This repository was archived by the owner on Dec 20, 2024. It is now read-only.
I want to do what I can do with vercel cli from the admin screen. #4813
Locked
kahirokunn
started this conversation in
Idea
Replies: 1 comment 4 replies
-
|
It does not yet exist, but I also would like to see this. However, we do publish an OpenAPI spec of all the API endpoints, so in theory it should be possible to generate a TypeScript client for this. |
Beta Was this translation helpful? Give feedback.
4 replies
-
|
I tried to generate it, but the path parameter was not defined and it seemed to provide an inconsistent OpenAPI. "/v1/domains/{domain}/registry": {
"get": {
"description": "Fetch domain transfer availability or transfer status if a transfer is in progress.",
"operationId": "getDomainTransfer",
"security": [
{
"bearerToken": []
}
],
"summary": "Get domain transfer info.",
"tags": [
"domains"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"transferable": {
"type": "boolean",
"description": "Whether or not the domain is transferable"
},
"transferPolicy": {
"nullable": true,
"type": "string",
"enum": [
"charge-and-renew",
"no-charge-no-change",
"no-change",
"new-term",
"not-supported"
],
"description": "The domain's transfer policy (depends on TLD requirements). `charge-and-renew`: transfer will charge for renewal and will renew the existing domain's registration. `no-charge-no-change`: transfer will have no change to registration period and does not require charge. `no-change`: transfer charge is required, but no change in registration period. `new-term`: transfer charge is required and a new registry term is set based on the transfer date. `not-supported`: transfers are not supported for this domain or TLD. `null`: This TLD is not supported by Vercel's Registrar."
},
"reason": {
"type": "string",
"description": "Description associated with transferable state."
},
"status": {
"type": "string",
"enum": [
"pending_owner",
"pending_admin",
"pending_registry",
"completed",
"cancelled",
"undef",
"unknown"
],
"description": "The current state of an ongoing transfer. `pending_owner`: Awaiting approval by domain's admin contact (every transfer begins with this status). If approval is not given within five days, the transfer is cancelled. `pending_admin`: Waiting for approval by Vercel Registrar admin. `pending_registry`: Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar). `completed`: The transfer completed successfully. `cancelled`: The transfer was cancelled. `undef`: No transfer exists for this domain. `unknown`: This TLD is not supported by Vercel's Registrar."
}
},
"required": [
"transferable",
"transferPolicy",
"reason",
"status"
],
"type": "object"
}
}
}
},
"400": {
"description": ""
},
"401": {
"description": ""
},
"403": {
"description": "You do not have permission to access this resource."
}
},
"parameters": [
{
"description": "The Team identifier or slug to perform the request on behalf of.",
"in": "query",
"name": "teamId",
"schema": {
"type": "string"
}
}
]
}
}, |
Beta Was this translation helpful? Give feedback.
-
|
The operationId is covered. The operationId gitNamespaces is used in "/v1/integrations/git-namespaces", and the operationId gitNamespaces is also used in "search-repo". "/v1/integrations/search-repo": {
"get": {
"description": "Lists git repositories linked to a namespace `id` for a supported provider. A specific namespace `id` can be obtained via the `git-namespaces` endpoint. Supported providers are `github`, `gitlab` and `bitbucket`. If the provider or namespace is not provided, it will try to obtain it from the user that authenticated the request.",
"operationId": "gitNamespaces",
"security": [
{
"bearerToken": []
}
],
"summary": "List git repositories linked to namespace by provider",
"tags": [
"integrations"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"properties": {
"gitAccount": {
"properties": {
"provider": {
"type": "string",
"enum": [
"github",
"github-custom-host",
"gitlab",
"bitbucket"
]
},
"namespaceId": {
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"required": [
"provider",
"namespaceId"
],
"type": "object"
},
"repos": {
"items": {
"properties": {
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"provider": {
"type": "string",
"enum": [
"github",
"github-custom-host",
"gitlab",
"bitbucket"
]
},
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"namespace": {
"type": "string"
},
"owner": {
"properties": {
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"ownerType": {
"type": "string",
"enum": [
"user",
"team"
]
},
"private": {
"type": "boolean"
},
"defaultBranch": {
"type": "string"
},
"updatedAt": {
"type": "number"
}
},
"required": [
"id",
"provider",
"url",
"name",
"slug",
"namespace",
"owner",
"ownerType",
"private",
"defaultBranch",
"updatedAt"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"gitAccount",
"repos"
],
"type": "object"
}
}
}
},
"400": {
"description": "One of the provided values in the request query is invalid."
},
"403": {
"description": "You do not have permission to access this resource."
}
},
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "namespaceId",
"in": "query",
"schema": {
"type": [
"string",
"number"
],
"nullable": true
}
},
{
"name": "provider",
"in": "query",
"schema": {
"enum": [
"github",
"github-custom-host",
"gitlab",
"bitbucket"
]
}
},
{
"name": "installationId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "host",
"description": "The custom Git host if using a custom Git provider, like GitHub Enterprise Server",
"in": "query",
"schema": {
"description": "The custom Git host if using a custom Git provider, like GitHub Enterprise Server",
"type": "string",
"example": "ghes-test.now.systems"
}
},
{
"description": "The Team identifier or slug to perform the request on behalf of.",
"in": "query",
"name": "teamId",
"schema": {
"type": "string"
}
}
]
}
}If OpenAPI integrity is not maintained, automatic generation is not possible. |
Beta Was this translation helpful? Give feedback.
-
|
Duplicate parameters for forceNew and skipAutoDetectionConfirmation in "/v13/deployments": {
"post": {
"description": "Create a new deployment with all the required and intended data. If the deployment is not a git deployment, all files must be provided with the request, either referenced or inlined. Additionally, a deployment id can be specified to redeploy a previous deployment.",
"operationId": "createDeployment",
"security": [
{
"bearerToken": []
}
],
"summary": "Create a new deployment",
"tags": [
"deployments"
],
"responses": {
"200": {
"description": "The successfully created deployment",
"content": {
"application/json": {
"schema": {
"properties": {
"build": {
"properties": {
"env": {
"items": {
"type": "string"
},
"type": "array",
"description": "The keys of the environment variables that were assigned during the build phase.",
"example": [
"MY_ENV_VAR"
]
}
},
"required": [
"env"
],
"type": "object"
},
"builds": {
"items": {
"type": "object"
},
"type": "array"
},
"connectBuildsEnabled": {
"type": "boolean",
"description": "The flag saying if Vercel Connect configuration is used for builds"
},
"connectConfigurationId": {
"type": "string",
"description": "The ID of Vercel Connect configuration used for this deployment"
},
"createdIn": {
"type": "string",
"description": "The region where the deployment was first created",
"example": "sfo1"
},
"env": {
"items": {
"type": "string"
},
"type": "array",
"description": "The keys of the environment variables that were assigned during runtime",
"example": [
"MY_SECRET"
]
},
"functions": {
"nullable": true,
"additionalProperties": {
"properties": {
"memory": {
"type": "number"
},
"maxDuration": {
"type": "number"
},
"runtime": {
"type": "string"
},
"includeFiles": {
"type": "string"
},
"excludeFiles": {
"type": "string"
}
},
"type": "object",
"description": "An object used to configure your Serverless Functions",
"example": {
"api/test.js": {
"memory": 3008
}
}
},
"type": "object",
"description": "An object used to configure your Serverless Functions",
"example": {
"api/test.js": {
"memory": 3008
}
}
},
"inspectorUrl": {
"nullable": true,
"type": "string",
"description": "Vercel URL to inspect the deployment.",
"example": "https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq"
},
"isInConcurrentBuildsQueue": {
"type": "boolean",
"description": "Is the deployment currently queued waiting for a Concurrent Build Slot to be available",
"example": false
},
"meta": {
"additionalProperties": {
"type": "string",
"description": "An object containing the deployment's metadata",
"example": {
"foo": "bar"
}
},
"type": "object",
"description": "An object containing the deployment's metadata",
"example": {
"foo": "bar"
}
},
"monorepoManager": {
"nullable": true,
"type": "string",
"description": "An monorepo manager that was used for the deployment",
"example": "turbo"
},
"name": {
"type": "string",
"description": "The name of the project associated with the deployment at the time that the deployment was created",
"example": "my-project"
},
"ownerId": {
"type": "string",
"description": "The unique ID of the user or team the deployment belongs to",
"example": "ZspSRT4ljIEEmMHgoDwKWDei"
},
"passiveConnectConfigurationId": {
"type": "string",
"description": "The connect configuration ID used to deploy passive lambdas into for secure compute enabled deployments."
},
"plan": {
"type": "string",
"enum": [
"pro",
"enterprise",
"hobby",
"oss"
],
"description": "The pricing plan the deployment was made under",
"example": "pro"
},
"projectId": {
"type": "string",
"description": "The ID of the project the deployment is associated with",
"example": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
},
"routes": {
"nullable": true,
"items": {
"oneOf": [
{
"properties": {
"src": {
"type": "string"
},
"dest": {
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"methods": {
"items": {
"type": "string"
},
"type": "array"
},
"continue": {
"type": "boolean"
},
"override": {
"type": "boolean"
},
"caseSensitive": {
"type": "boolean"
},
"check": {
"type": "boolean"
},
"important": {
"type": "boolean"
},
"status": {
"type": "number"
},
"has": {
"items": {
"oneOf": [
{
"properties": {
"type": {
"type": "string",
"enum": [
"host"
]
},
"value": {
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"key"
],
"type": "object"
}
]
},
"type": "array"
},
"missing": {
"items": {
"oneOf": [
{
"properties": {
"type": {
"type": "string",
"enum": [
"host"
]
},
"value": {
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"key"
],
"type": "object"
}
]
},
"type": "array"
},
"locale": {
"properties": {
"redirect": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"cookie": {
"type": "string"
}
},
"type": "object"
},
"middlewarePath": {
"type": "string",
"description": "A middleware key within the `output` key under the build result. Overrides a `middleware` definition."
},
"middlewareRawSrc": {
"items": {
"type": "string"
},
"type": "array",
"description": "The original middleware matchers."
},
"middleware": {
"type": "number",
"description": "A middleware index in the `middleware` key under the build result"
}
},
"required": [
"src"
],
"type": "object",
"description": "A list of routes objects used to rewrite paths to point towards other internal or external paths",
"example": [
{
"src": "/docs",
"dest": "https://docs.example.com"
}
]
},
{
"properties": {
"handle": {
"type": "string",
"enum": [
"error",
"filesystem",
"hit",
"miss",
"rewrite",
"resource"
]
},
"src": {
"type": "string"
},
"dest": {
"type": "string"
},
"status": {
"type": "number"
}
},
"required": [
"handle"
],
"type": "object",
"description": "A list of routes objects used to rewrite paths to point towards other internal or external paths",
"example": [
{
"src": "/docs",
"dest": "https://docs.example.com"
}
]
},
{
"properties": {
"src": {
"type": "string"
},
"continue": {
"type": "boolean"
},
"middleware": {
"type": "number",
"enum": [
0
]
}
},
"required": [
"src",
"continue",
"middleware"
],
"type": "object",
"description": "A list of routes objects used to rewrite paths to point towards other internal or external paths",
"example": [
{
"src": "/docs",
"dest": "https://docs.example.com"
}
]
}
]
},
"type": "array",
"description": "A list of routes objects used to rewrite paths to point towards other internal or external paths",
"example": [
{
"src": "/docs",
"dest": "https://docs.example.com"
}
]
},
"gitRepo": {
"nullable": true,
"oneOf": [
{
"properties": {
"namespace": {
"type": "string"
},
"projectId": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"gitlab"
]
},
"url": {
"type": "string"
},
"path": {
"type": "string"
},
"defaultBranch": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"ownerType": {
"type": "string",
"enum": [
"team",
"user"
]
}
},
"required": [
"namespace",
"projectId",
"type",
"url",
"path",
"defaultBranch",
"name",
"private",
"ownerType"
],
"type": "object"
},
{
"properties": {
"org": {
"type": "string"
},
"repo": {
"type": "string"
},
"repoId": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"github"
]
},
"repoOwnerId": {
"type": "string"
},
"path": {
"type": "string"
},
"defaultBranch": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"ownerType": {
"type": "string",
"enum": [
"team",
"user"
]
}
},
"required": [
"org",
"repo",
"repoId",
"type",
"repoOwnerId",
"path",
"defaultBranch",
"name",
"private",
"ownerType"
],
"type": "object"
},
{
"properties": {
"owner": {
"type": "string"
},
"repoUuid": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"bitbucket"
]
},
"workspaceUuid": {
"type": "string"
},
"path": {
"type": "string"
},
"defaultBranch": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"ownerType": {
"type": "string",
"enum": [
"team",
"user"
]
}
},
"required": [
"owner",
"repoUuid",
"slug",
"type",
"workspaceUuid",
"path",
"defaultBranch",
"name",
"private",
"ownerType"
],
"type": "object"
}
]
},
"aliasAssignedAt": {
"nullable": true,
"oneOf": [
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"lambdas": {
"items": {
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "number"
},
"entrypoint": {
"nullable": true,
"type": "string"
},
"readyState": {
"type": "string",
"enum": [
"BUILDING",
"ERROR",
"INITIALIZING",
"READY"
]
},
"readyStateAt": {
"type": "number"
},
"output": {
"items": {
"properties": {
"path": {
"type": "string"
},
"functionName": {
"type": "string"
}
},
"required": [
"path",
"functionName"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"output"
],
"type": "object"
},
"type": "array"
},
"public": {
"type": "boolean",
"description": "A boolean representing if the deployment is public or not. By default this is `false`",
"example": false
},
"readyState": {
"type": "string",
"enum": [
"QUEUED",
"BUILDING",
"ERROR",
"INITIALIZING",
"READY",
"CANCELED"
],
"description": "The state of the deployment depending on the process of deploying, or if it is ready or in an error state",
"example": "READY"
},
"readySubstate": {
"type": "string",
"enum": [
"STAGED",
"PROMOTED"
],
"description": "The substate of the deployment when the state is \"READY\"",
"example": "STAGED"
},
"regions": {
"items": {
"type": "string"
},
"type": "array",
"description": "The regions the deployment exists in",
"example": [
"sfo1"
]
},
"source": {
"type": "string",
"enum": [
"api-trigger-git-deploy",
"cli",
"clone/repo",
"git",
"import",
"import/repo"
],
"description": "Where was the deployment created from",
"example": "cli"
},
"target": {
"nullable": true,
"type": "string",
"enum": [
"staging",
"production"
],
"description": "If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned",
"example": null
},
"team": {
"properties": {
"id": {
"type": "string",
"description": "The ID of the team owner",
"example": "team_LLHUOMOoDlqOp8wPE4kFo9pE"
},
"name": {
"type": "string",
"description": "The name of the team owner",
"example": "FSociety"
},
"slug": {
"type": "string",
"description": "The slug of the team owner",
"example": "fsociety"
}
},
"required": [
"id",
"name",
"slug"
],
"type": "object",
"description": "The team that owns the deployment if any"
},
"type": {
"type": "string",
"enum": [
"LAMBDAS"
]
},
"url": {
"type": "string",
"description": "A string with the unique URL of the deployment",
"example": "my-instant-deployment-3ij3cxz9qr.now.sh"
},
"userAliases": {
"items": {
"type": "string"
},
"type": "array",
"description": "An array of domains that were provided by the user when creating the Deployment.",
"example": [
"sub1.example.com",
"sub2.example.com"
]
},
"version": {
"type": "number",
"enum": [
2
],
"description": "The platform version that was used to create the deployment.",
"example": 2
},
"previewCommentsEnabled": {
"type": "boolean",
"description": "Whether or not preview comments are enabled for the deployment",
"example": false
},
"alias": {
"items": {
"type": "string"
},
"type": "array",
"description": "A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation",
"example": []
},
"aliasAssigned": {
"type": "boolean",
"description": "A boolean that will be true when the aliases from the alias property were assigned successfully",
"example": true
},
"aliasError": {
"nullable": true,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"description": "An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`",
"example": null
},
"aliasFinal": {
"nullable": true,
"type": "string"
},
"aliasWarning": {
"nullable": true,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"link": {
"type": "string"
},
"action": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"autoAssignCustomDomains": {
"type": "boolean"
},
"automaticAliases": {
"items": {
"type": "string"
},
"type": "array"
},
"bootedAt": {
"type": "number"
},
"buildErrorAt": {
"type": "number"
},
"buildingAt": {
"type": "number"
},
"canceledAt": {
"type": "number"
},
"checksState": {
"type": "string",
"enum": [
"registered",
"running",
"completed"
]
},
"checksConclusion": {
"type": "string",
"enum": [
"succeeded",
"failed",
"skipped",
"canceled"
]
},
"createdAt": {
"type": "number",
"description": "A number containing the date when the deployment was created in milliseconds",
"example": 1540257589405
},
"creator": {
"properties": {
"uid": {
"type": "string",
"description": "The ID of the user that created the deployment",
"example": "96SnxkFiMyVKsK3pnoHfx3Hz"
},
"username": {
"type": "string",
"description": "The username of the user that created the deployment",
"example": "john-doe"
}
},
"required": [
"uid"
],
"type": "object",
"description": "Information about the deployment creator"
},
"errorCode": {
"type": "string"
},
"errorLink": {
"type": "string"
},
"errorMessage": {
"nullable": true,
"type": "string"
},
"errorStep": {
"type": "string"
},
"passiveRegions": {
"items": {
"type": "string"
},
"type": "array"
},
"gitSource": {
"oneOf": [
{
"properties": {
"type": {
"type": "string",
"enum": [
"github"
]
},
"repoId": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"ref": {
"nullable": true,
"type": "string"
},
"sha": {
"type": "string"
},
"prId": {
"nullable": true,
"type": "number"
}
},
"required": [
"type",
"repoId"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"github"
]
},
"org": {
"type": "string"
},
"repo": {
"type": "string"
},
"ref": {
"nullable": true,
"type": "string"
},
"sha": {
"type": "string"
},
"prId": {
"nullable": true,
"type": "number"
}
},
"required": [
"type",
"org",
"repo"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"gitlab"
]
},
"projectId": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"ref": {
"nullable": true,
"type": "string"
},
"sha": {
"type": "string"
},
"prId": {
"nullable": true,
"type": "number"
}
},
"required": [
"type",
"projectId"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"bitbucket"
]
},
"workspaceUuid": {
"type": "string"
},
"repoUuid": {
"type": "string"
},
"ref": {
"nullable": true,
"type": "string"
},
"sha": {
"type": "string"
},
"prId": {
"nullable": true,
"type": "number"
}
},
"required": [
"type",
"repoUuid"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"bitbucket"
]
},
"owner": {
"type": "string"
},
"slug": {
"type": "string"
},
"ref": {
"nullable": true,
"type": "string"
},
"sha": {
"type": "string"
},
"prId": {
"nullable": true,
"type": "number"
}
},
"required": [
"type",
"owner",
"slug"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"custom"
]
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"gitUrl": {
"type": "string"
}
},
"required": [
"type",
"ref",
"sha",
"gitUrl"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"github"
]
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"repoId": {
"type": "number"
},
"org": {
"type": "string"
},
"repo": {
"type": "string"
}
},
"required": [
"type",
"ref",
"sha",
"repoId"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"gitlab"
]
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"projectId": {
"type": "number"
}
},
"required": [
"type",
"ref",
"sha",
"projectId"
],
"type": "object"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"bitbucket"
]
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"owner": {
"type": "string"
},
"slug": {
"type": "string"
},
"workspaceUuid": {
"type": "string"
},
"repoUuid": {
"type": "string"
}
},
"required": [
"type",
"ref",
"sha",
"workspaceUuid",
"repoUuid"
],
"type": "object"
}
]
},
"id": {
"type": "string",
"description": "A string holding the unique ID of the deployment",
"example": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
}
},
"required": [
"build",
"createdIn",
"env",
"inspectorUrl",
"isInConcurrentBuildsQueue",
"meta",
"name",
"ownerId",
"plan",
"projectId",
"routes",
"public",
"readyState",
"regions",
"type",
"url",
"version",
"alias",
"aliasAssigned",
"bootedAt",
"buildingAt",
"createdAt",
"creator",
"id"
],
"type": "object",
"description": "The successfully created deployment"
}
}
}
},
"400": {
"description": "One of the provided values in the request body is invalid.\nOne of the provided values in the request query is invalid."
},
"401": {
"description": ""
},
"402": {
"description": "The account was soft-blocked for an unhandled reason.\nThe account is missing a payment so payment method must be updated\nDeploying to Serverless Functions to multiple regions requires a plan update"
},
"403": {
"description": "You do not have permission to access this resource."
},
"404": {
"description": ""
},
"409": {
"description": "The deployment project is being transferred"
}
},
"parameters": [
{
"name": "forceNew",
"description": "Forces a new deployment even if there is a previous similar deployment",
"in": "query",
"schema": {
"description": "Forces a new deployment even if there is a previous similar deployment",
"enum": [
"0",
"1"
]
}
},
{
"name": "skipAutoDetectionConfirmation",
"description": "Allows to skip framework detection so the API would not fail to ask for confirmation",
"in": "query",
"schema": {
"description": "Allows to skip framework detection so the API would not fail to ask for confirmation",
"enum": [
"0",
"1"
]
}
},
{
"name": "forceNew",
"description": "Forces a new deployment even if there is a previous similar deployment",
"in": "query",
"schema": {
"description": "Forces a new deployment even if there is a previous similar deployment",
"enum": [
"0",
"1"
]
}
},
{
"name": "skipAutoDetectionConfirmation",
"description": "Allows to skip framework detection so the API would not fail to ask for confirmation",
"in": "query",
"schema": {
"description": "Allows to skip framework detection so the API would not fail to ask for confirmation",
"enum": [
"0",
"1"
]
}
},
{
"description": "The Team identifier or slug to perform the request on behalf of.",
"in": "query",
"name": "teamId",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"$schema": {
"description": "Ignored. Can be set to get completions, validations and documentation in some editors.",
"example": [
"https://openapi.vercel.sh/vercel.json"
],
"type": "string"
},
"alias": {
"description": "Aliases that will get assigned when the deployment is `READY` and the target is `production`. The client needs to make a `GET` request to its API to ensure the assignment",
"example": [
"example.vercel.app"
],
"items": {
"maxLength": 253,
"type": "string"
},
"maxItems": 50,
"maxLength": 253,
"type": "array"
},
"build": {
"additionalProperties": false,
"description": "An object containing another object with information to be passed to the Build Process",
"deprecated": true,
"properties": {
"env": {
"additionalProperties": {
"maxLength": 65536,
"type": "string"
},
"description": "An object containing the deployment's environment variable names and values to be passed to Builds. Secrets can be referenced by prefixing the value with `@`",
"example": {
"A_SECRET": "@a-secret"
},
"deprecated": true,
"maxProperties": 100,
"minProperties": 0,
"type": "object"
}
},
"type": "object"
},
"builds": {
"description": "A list of build descriptions whose src references valid source files.",
"deprecated": true,
"items": {
"additionalProperties": false,
"properties": {
"config": {
"description": "Optionally, an object including arbitrary metadata to be passed to the Builder",
"type": "object"
},
"src": {
"description": "A glob expression or pathname. If more than one file is resolved, one build will be created per matched file. It can include `*` and `**`",
"maxLength": 4096,
"type": "string"
},
"use": {
"description": "An npm module to be installed by the build process. It can include a semver compatible version (e.g.: `@org/proj@1`)",
"maxLength": 256,
"type": "string"
}
},
"required": [
"use"
],
"type": "object"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"cleanUrls": {
"description": "When set to `true`, all HTML files and Serverless Functions will have their extension removed. When visiting a path that ends with the extension, a 308 response will redirect the client to the extensionless path.",
"type": "boolean"
},
"env": {
"additionalProperties": {
"maxLength": 65536,
"type": "string"
},
"description": "An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with `@`",
"example": {
"A_SECRET": "@a-secret"
},
"deprecated": true,
"maxProperties": 100,
"minProperties": 0,
"type": "object"
},
"passiveRegions": {
"description": "An array of the passive regions the deployment's Serverless Functions should be deployed to that can be failed over to during a lambda outage",
"example": [
"iad1",
"cle1"
],
"items": {
"maxLength": 256,
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
},
"functions": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"excludeFiles": {
"description": "A glob pattern to match files that should be excluded from your Serverless Function. If you’re using a Community Runtime, the behavior might vary.",
"maxLength": 256,
"type": "string"
},
"includeFiles": {
"description": "A glob pattern to match files that should be included in your Serverless Function. If you’re using a Community Runtime, the behavior might vary.",
"maxLength": 256,
"type": "string"
},
"maxDuration": {
"description": "An integer defining how long your Serverless Function should be allowed to run on every request in seconds (between 1 and the maximum limit of your plan).",
"maximum": 900,
"minimum": 1,
"type": "number"
},
"memory": {
"description": "An integer defining the memory your Serverless Function should be provided with (between 128 and 3008).",
"maximum": 3008,
"minimum": 128,
"type": "number"
},
"runtime": {
"description": "The npm package name of a Runtime, including its version",
"maxLength": 256,
"type": "string"
}
},
"type": "object"
},
"description": "An object describing custom options for your Serverless Functions. Each key must be glob pattern that matches the paths of the Serverless Functions you would like to customize (like `api/*.js` or `api/test.js`).",
"example": {
"src/pages/**": {
"maxDuration": 6,
"memory": 1024
}
},
"maxProperties": 50,
"minProperties": 1,
"type": "object"
},
"git": {
"type": "object",
"properties": {
"deploymentEnabled": {
"description": "Specifies the branches that will not trigger an auto-deployment when committing to them. Any non specified branch is `true` by default.",
"example": {
"main": false
},
"oneOf": [
{
"type": "boolean"
},
{
"type": "object",
"additionalProperties": {
"type": "boolean"
}
}
]
}
}
},
"headers": {
"type": "array",
"maxItems": 1024,
"description": "A list of header definitions.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"headers"
],
"properties": {
"source": {
"description": "A pattern that matches each incoming pathname (excluding querystring)",
"type": "string",
"maxLength": 4096
},
"headers": {
"description": "An array of key/value pairs representing each response header.",
"type": "array",
"maxItems": 1024,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"maxLength": 4096
},
"value": {
"type": "string",
"maxLength": 4096
}
}
}
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
}
}
}
},
"images": {
"type": "object",
"additionalProperties": false,
"required": [
"sizes"
],
"properties": {
"contentDispositionType": {
"enum": [
"inline",
"attachment"
]
},
"contentSecurityPolicy": {
"type": "string",
"maxLength": 256
},
"dangerouslyAllowSVG": {
"type": "boolean"
},
"domains": {
"type": "array",
"minItems": 0,
"maxItems": 50,
"items": {
"type": "string",
"maxLength": 256
}
},
"formats": {
"type": "array",
"minItems": 1,
"maxItems": 4,
"items": {
"enum": [
"image/avif",
"image/webp",
"image/jpeg",
"image/png"
]
}
},
"minimumCacheTTL": {
"type": "integer",
"minimum": 1,
"maximum": 315360000
},
"remotePatterns": {
"type": "array",
"minItems": 0,
"maxItems": 50,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"hostname"
],
"properties": {
"protocol": {
"enum": [
"http",
"https"
]
},
"hostname": {
"type": "string",
"maxLength": 256
},
"port": {
"type": "string",
"maxLength": 5
},
"pathname": {
"type": "string",
"maxLength": 256
}
}
}
},
"sizes": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "number"
}
}
}
},
"name": {
"description": "A string with the project name used in the deployment URL",
"example": "my-instant-deployment",
"type": "string"
},
"public": {
"description": "Whether a deployment's source and logs are available publicly",
"type": "boolean"
},
"redirects": {
"title": "Redirects",
"type": "array",
"maxItems": 1024,
"description": "A list of redirect definitions.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"destination"
],
"properties": {
"source": {
"description": "A pattern that matches each incoming pathname (excluding querystring).",
"type": "string",
"maxLength": 4096
},
"destination": {
"description": "A location destination defined as an absolute pathname or external URL.",
"type": "string",
"maxLength": 4096
},
"permanent": {
"description": "A boolean to toggle between permanent and temporary redirect. When `true`, the status code is `308`. When `false` the status code is `307`.",
"type": "boolean"
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
}
}
}
},
"regions": {
"description": "An array of the regions the deployment's Serverless Functions should be deployed to",
"example": [
"sfo",
"bru"
],
"items": {
"maxLength": 256,
"type": "string"
},
"maxItems": 1000,
"minItems": 1,
"type": "array"
},
"rewrites": {
"type": "array",
"maxItems": 1024,
"description": "A list of rewrite definitions.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"destination"
],
"properties": {
"source": {
"description": "A pattern that matches each incoming pathname (excluding querystring).",
"type": "string",
"maxLength": 4096
},
"destination": {
"description": "An absolute pathname to an existing resource or an external URL.",
"type": "string",
"maxLength": 4096
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"statusCode": {
"description": "An optional integer to override the status code of the response.",
"type": "integer",
"minimum": 100,
"maximum": 999
}
}
}
},
"routes": {
"type": "array",
"maxItems": 1024,
"deprecated": true,
"description": "A list of routes objects used to rewrite paths to point towards other internal or external paths",
"example": [
{
"dest": "https://docs.example.com",
"src": "/docs"
}
],
"items": {
"anyOf": [
{
"type": "object",
"required": [
"src"
],
"additionalProperties": false,
"properties": {
"src": {
"type": "string",
"maxLength": 4096
},
"dest": {
"type": "string",
"maxLength": 4096
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 4096
},
"minProperties": 1,
"maxProperties": 100
},
"methods": {
"type": "array",
"maxItems": 10,
"items": {
"type": "string",
"maxLength": 32
}
},
"caseSensitive": {
"type": "boolean"
},
"important": {
"type": "boolean"
},
"user": {
"type": "boolean"
},
"continue": {
"type": "boolean"
},
"override": {
"type": "boolean"
},
"check": {
"type": "boolean"
},
"isInternal": {
"type": "boolean"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 999
},
"locale": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"redirect": {
"type": "object",
"additionalProperties": {
"type": "string",
"maxLength": 4096
},
"minProperties": 1,
"maxProperties": 100
},
"value": {
"type": "string",
"maxLength": 4096
},
"path": {
"type": "string",
"maxLength": 4096
},
"cookie": {
"type": "string",
"maxLength": 4096
},
"default": {
"type": "string",
"maxLength": 4096
}
}
},
"middleware": {
"type": "number"
},
"middlewarePath": {
"type": "string"
},
"middlewareRawSrc": {
"type": "array",
"items": {
"type": "string"
}
},
"has": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
},
"missing": {
"description": "An array of requirements that are needed to match",
"type": "array",
"maxItems": 16,
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"value"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"host"
]
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"key"
],
"properties": {
"type": {
"description": "The type of request element to check",
"type": "string",
"enum": [
"header",
"cookie",
"query"
]
},
"key": {
"description": "The name of the element contained in the particular type",
"type": "string",
"maxLength": 4096
},
"value": {
"description": "A regular expression used to match the value. Named groups can be used in the destination",
"type": "string",
"maxLength": 4096
}
}
}
]
}
}
}
},
{
"type": "object",
"required": [
"handle"
],
"additionalProperties": false,
"properties": {
"handle": {
"type": "string",
"maxLength": 32,
"enum": [
"error",
"filesystem",
"hit",
"miss",
"resource",
"rewrite"
]
}
}
}
]
}
},
"trailingSlash": {
"description": "When `false`, visiting a path that ends with a forward slash will respond with a `308` status code and redirect to the path without the trailing slash.",
"type": "boolean"
},
"buildCommand": {
"description": "The build command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"ignoreCommand": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"devCommand": {
"description": "The dev command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"framework": {
"description": "The framework that is being used for this project. When `null` is used no framework is selected",
"type": "string",
"enum": [
null,
"blitzjs",
"nextjs",
"gatsby",
"remix",
"astro",
"hexo",
"eleventy",
"docusaurus-2",
"docusaurus",
"preact",
"solidstart",
"dojo",
"ember",
"vue",
"scully",
"ionic-angular",
"angular",
"polymer",
"svelte",
"sveltekit",
"sveltekit-1",
"ionic-react",
"create-react-app",
"gridsome",
"umijs",
"sapper",
"saber",
"stencil",
"nuxtjs",
"redwoodjs",
"hugo",
"jekyll",
"brunch",
"middleman",
"zola",
"hydrogen",
"vite",
"vitepress",
"vuepress",
"parcel",
"sanity",
"storybook"
],
"nullable": true
},
"installCommand": {
"description": "The install command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"outputDirectory": {
"description": "The output directory of the project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"crons": {
"description": "An array of cron jobs that should be created for production Deployments.",
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"required": [
"schedule",
"path"
],
"properties": {
"schedule": {
"type": "string",
"maxLength": 256
},
"path": {
"type": "string",
"maxLength": 512,
"pattern": "^/.*"
}
}
}
},
"deploymentId": {
"description": "An deployment id for an existing deployment to redeploy",
"type": "string"
},
"files": {
"description": "A list of objects with the files to be deployed",
"items": {
"oneOf": [
{
"additionalProperties": false,
"description": "Used in the case you want to inline a file inside the request",
"properties": {
"data": {
"description": "The file content, it could be either a `base64` (useful for images, etc.) of the files or the plain content for source code",
"type": "string"
},
"encoding": {
"description": "The file content encoding, it could be either a base64 (useful for images, etc.) of the files or the plain text for source code.",
"enum": [
"base64",
"utf-8"
]
},
"file": {
"description": "The file name including the whole path",
"example": "folder/file.js",
"type": "string"
}
},
"required": [
"file",
"data"
],
"title": "InlinedFile",
"type": "object"
},
{
"additionalProperties": false,
"description": "Used in the case you want to reference a file that was already uploaded",
"properties": {
"file": {
"description": "The file path relative to the project root",
"example": "folder/file.js",
"type": "string"
},
"sha": {
"description": "The file contents hashed with SHA1, used to check the integrity",
"type": "string"
},
"size": {
"description": "The file size in bytes",
"type": "integer"
}
},
"required": [
"file"
],
"title": "UploadedFile",
"type": "object"
}
]
},
"type": "array"
},
"gitMetadata": {
"description": "Populates initial git metadata for different git providers.",
"additionalProperties": false,
"type": "object",
"properties": {
"remoteUrl": {
"type": "string",
"description": "The git repository's remote origin url",
"example": "https://github.com/vercel/next.js"
},
"commitAuthorName": {
"type": "string",
"description": "The name of the author of the commit",
"example": "kyliau"
},
"commitMessage": {
"type": "string",
"description": "The commit message",
"example": "add method to measure Interaction to Next Paint (INP) (#36490)"
},
"commitRef": {
"type": "string",
"description": "The branch on which the commit was made",
"example": "main"
},
"commitSha": {
"type": "string",
"description": "The hash of the commit",
"example": "dc36199b2234c6586ebe05ec94078a895c707e29"
},
"dirty": {
"type": "boolean",
"description": "Whether or not there have been modifications to the working tree since the latest commit",
"example": true
}
}
},
"gitSource": {
"description": "Defines the Git Repository source to be deployed. This property can not be used in combination with `files`.",
"anyOf": [
{
"properties": {
"ref": {
"type": "string"
},
"repoId": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"sha": {
"type": "string"
},
"type": {
"enum": [
"github"
],
"type": "string"
}
},
"required": [
"type",
"ref",
"repoId"
],
"type": "object"
},
{
"properties": {
"org": {
"type": "string"
},
"ref": {
"type": "string"
},
"repo": {
"type": "string"
},
"sha": {
"type": "string"
},
"type": {
"enum": [
"github"
],
"type": "string"
}
},
"required": [
"type",
"ref",
"org",
"repo"
],
"type": "object"
},
{
"properties": {
"projectId": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"type": {
"enum": [
"gitlab"
],
"type": "string"
}
},
"required": [
"type",
"ref",
"projectId"
],
"type": "object"
},
{
"properties": {
"ref": {
"type": "string"
},
"repoUuid": {
"type": "string"
},
"sha": {
"type": "string"
},
"type": {
"enum": [
"bitbucket"
],
"type": "string"
},
"workspaceUuid": {
"type": "string"
}
},
"required": [
"type",
"ref",
"repoUuid"
],
"type": "object"
},
{
"properties": {
"owner": {
"type": "string"
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"enum": [
"bitbucket"
],
"type": "string"
}
},
"required": [
"type",
"ref",
"owner",
"slug"
],
"type": "object"
}
]
},
"meta": {
"additionalProperties": {
"maxLength": 65536,
"type": "string"
},
"description": "An object containing the deployment's metadata. Multiple key-value pairs can be attached to a deployment",
"example": {
"foo": "bar"
},
"maxProperties": 100,
"type": "object"
},
"monorepoManager": {
"description": "The monorepo manager that is being used for this deployment. When `null` is used no monorepo manager is selected",
"type": "string",
"nullable": true
},
"project": {
"type": "object",
"required": [
"id",
"region_id",
"name",
"pg_version",
"proxy_host",
"branch_logical_size_limit",
"branch_logical_size_limit_bytes",
"store_passwords",
"created_at",
"updated_at",
"owner_id"
],
"properties": {
"id": {
"type": "string"
},
"region_id": {
"type": "string"
},
"name": {
"type": "string"
},
"pg_version": {
"type": "number"
},
"proxy_host": {
"type": "string"
},
"branch_logical_size_limit": {
"type": "number",
"description": "The logical size limit for a branch in MiB."
},
"branch_logical_size_limit_bytes": {
"type": "number",
"description": "The logical size limit for a branch in bytes."
},
"synthetic_storage_size": {
"type": "number",
"description": "The data storage size in bytes."
},
"store_passwords": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"quota_reset_at": {
"type": "string"
},
"data_storage_bytes_hour": {
"type": "number"
},
"data_transfer_bytes": {
"type": "number"
},
"written_data_bytes": {
"type": "number"
},
"active_time_seconds": {
"type": "number"
},
"compute_time_seconds": {
"type": "number"
},
"settings": {
"type": "object",
"properties": {
"quota": {
"type": "object",
"properties": {
"compute_time_seconds": {
"type": "number",
"description": "The total amount of CPU seconds allowed to be spent by a project's compute endpoints."
},
"active_time_seconds": {
"type": "number",
"description": "The total amount of wall-clock time allowed to be spent by a project's compute endpoints."
},
"written_data_bytes": {
"type": "number",
"description": "The total amount of data written to all project's branches."
},
"data_transfer_bytes": {
"type": "number",
"description": "The total amount of data transferred from all project's branches using proxy."
},
"logical_size_bytes": {
"type": "number",
"description": "The logical size of every project's branch."
}
}
}
}
}
}
},
"projectSettings": {
"additionalProperties": false,
"description": "Project settings that will be applied to the deployment. It is required for the first deployment of a project and will be saved for any following deployments",
"properties": {
"buildCommand": {
"description": "The build command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"commandForIgnoringBuildStep": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"devCommand": {
"description": "The dev command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"framework": {
"description": "The framework that is being used for this project. When `null` is used no framework is selected",
"type": "string",
"enum": [
null,
"blitzjs",
"nextjs",
"gatsby",
"remix",
"astro",
"hexo",
"eleventy",
"docusaurus-2",
"docusaurus",
"preact",
"solidstart",
"dojo",
"ember",
"vue",
"scully",
"ionic-angular",
"angular",
"polymer",
"svelte",
"sveltekit",
"sveltekit-1",
"ionic-react",
"create-react-app",
"gridsome",
"umijs",
"sapper",
"saber",
"stencil",
"nuxtjs",
"redwoodjs",
"hugo",
"jekyll",
"brunch",
"middleman",
"zola",
"hydrogen",
"vite",
"vitepress",
"vuepress",
"parcel",
"sanity",
"storybook"
],
"nullable": true
},
"installCommand": {
"description": "The install command for this project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"outputDirectory": {
"description": "The output directory of the project. When `null` is used this value will be automatically detected",
"maxLength": 256,
"type": "string",
"nullable": true
},
"rootDirectory": {
"description": "The name of a directory or relative path to the source code of your project. When `null` is used it will default to the project root",
"maxLength": 256,
"type": "string",
"nullable": true
},
"serverlessFunctionRegion": {
"description": "The region to deploy Serverless Functions in this project",
"maxLength": 4,
"type": "string",
"nullable": true
},
"skipGitConnectDuringLink": {
"description": "Opts-out of the message prompting a CLI user to connect a Git repository in `vercel link`.",
"type": "boolean",
"deprecated": true
},
"sourceFilesOutsideRootDirectory": {
"description": "Indicates if there are source files outside of the root directory, typically used for monorepos",
"type": "boolean"
}
},
"type": "object"
},
"target": {
"description": "Either not defined, `staging`, or `production`. If `staging`, a staging alias in the format `<project>-<team>.vercel.app` will be assigned. If `production`, any aliases defined in `alias` will be assigned. If omitted, the target will be `preview`",
"enum": [
"staging",
"production"
],
"type": "string"
},
"withLatestCommit": {
"description": "When `true` and `deploymentId` is passed in, the sha from the previous deployment's `gitSource` is removed forcing the latest commit to be used.",
"type": "boolean"
},
"connection_uris": {
"type": "array",
"items": {
"type": "object",
"required": [
"connection_uri"
],
"properties": {
"connection_uri": {
"type": "string",
"example": "postgres://user:[email protected]/neondb"
}
}
}
},
"roles": {
"type": "array",
"items": {
"type": "object",
"required": [
"branch_id",
"name",
"created_at",
"updated_at"
],
"properties": {
"branch_id": {
"type": "string"
},
"name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"protected": {
"type": "boolean"
},
"password": {
"type": "string"
}
}
}
},
"databases": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"branch_id",
"name",
"owner_name",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "number"
},
"branch_id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner_name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
},
"branch": {
"type": "object",
"required": [
"id",
"project_id",
"name",
"current_state",
"primary",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"name": {
"type": "string"
},
"current_state": {
"type": "string",
"enum": [
"init",
"ready"
]
},
"primary": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"parent_id": {
"type": "string"
}
}
},
"endpoints": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"id",
"project_id",
"branch_id",
"autoscaling_limit_min_cu",
"autoscaling_limit_max_cu",
"region_id",
"type",
"current_state",
"pooler_enabled",
"pooler_mode",
"disabled",
"passwordless_access",
"created_at",
"updated_at",
"suspend_timeout_seconds"
],
"properties": {
"host": {
"type": "string"
},
"id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"branch_id": {
"type": "string"
},
"autoscaling_limit_min_cu": {
"type": "number"
},
"autoscaling_limit_max_cu": {
"type": "number"
},
"region_id": {
"type": "string"
},
"type": {
"type": "string"
},
"current_state": {
"type": "string"
},
"pooler_enabled": {
"type": "boolean"
},
"pooler_mode": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"passwordless_access": {
"type": "boolean"
},
"last_active": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"suspend_timeout_seconds": {
"type": "number"
}
}
}
},
"endpoint": {
"type": "object",
"required": [
"host",
"id",
"project_id",
"branch_id",
"autoscaling_limit_min_cu",
"autoscaling_limit_max_cu",
"region_id",
"type",
"current_state",
"pooler_enabled",
"pooler_mode",
"disabled",
"passwordless_access",
"created_at",
"updated_at",
"suspend_timeout_seconds"
],
"properties": {
"host": {
"type": "string"
},
"id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"branch_id": {
"type": "string"
},
"autoscaling_limit_min_cu": {
"type": "number"
},
"autoscaling_limit_max_cu": {
"type": "number"
},
"region_id": {
"type": "string"
},
"type": {
"type": "string"
},
"current_state": {
"type": "string"
},
"pooler_enabled": {
"type": "boolean"
},
"pooler_mode": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"passwordless_access": {
"type": "boolean"
},
"last_active": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"suspend_timeout_seconds": {
"type": "number"
}
}
},
"database": {
"type": "object",
"required": [
"id",
"branch_id",
"name",
"owner_name",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "number"
},
"branch_id": {
"type": "string"
},
"name": {
"type": "string"
},
"owner_name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"role": {
"type": "object",
"required": [
"branch_id",
"name",
"created_at",
"updated_at"
],
"properties": {
"branch_id": {
"type": "string"
},
"name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"protected": {
"type": "boolean"
},
"password": {
"type": "string"
}
}
},
"password": {
"type": "string"
},
"projects": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"data_storage_bytes_hour",
"data_transfer_bytes",
"written_data_bytes",
"compute_time_seconds",
"synthetic_storage_size"
],
"properties": {
"id": {
"type": "string"
},
"data_storage_bytes_hour": {
"type": "number"
},
"data_storage_bytes_hour_updated_at": {
"type": "string"
},
"data_transfer_bytes": {
"type": "number"
},
"data_transfer_bytes_updated_at": {
"type": "string"
},
"written_data_bytes": {
"type": "number"
},
"written_data_bytes_updated_at": {
"type": "string"
},
"compute_time_seconds": {
"type": "number"
},
"compute_time_seconds_updated_at": {
"type": "string"
},
"synthetic_storage_size": {
"type": "number"
},
"synthetic_storage_size_updated_at": {
"type": "string"
}
}
}
},
"pagination": {
"type": "object",
"required": [
"cursor"
],
"properties": {
"cursor": {
"type": "string"
}
}
}
},
"required": [
"name",
"project",
"connection_uris",
"roles",
"databases",
"branch",
"endpoints",
"endpoint",
"database",
"role",
"password",
"projects",
"pagination"
]
}
}
}
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
Once that is fixed, I can automatically generate something like this. |
Beta Was this translation helpful? Give feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Therefore, we would like you to provide not only cli but also TypeScript functions.
Beta Was this translation helpful? Give feedback.
All reactions