openapi: 3.1.0 servers: - description: Production API url: https://api.vercel.com x-hasEquivalentPaths: true info: contact: email: support@vercel.com name: Vercel Support url: https://vercel.com/support description: Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work. title: Vercel API version: 0.0.1 x-apisguru-categories: - hosting x-logo: url: https://pbs.twimg.com/profile_images/1252531684353998848/6R0-p1Vf_400x400.jpg x-origin: - format: openapi url: https://openapi.vercel.sh version: "3.0" x-providerName: vercel.com paths: /registration: post: description: Request a new login for a user to get a token. This will respond with a verification token and send an email to confirm the request. Once confirmed you can use the verification token to get an authentication token. operationId: emailLogin parameters: [] requestBody: content: application/json: schema: properties: email: description: The user email. examples: - user@mail.com type: string tokenName: description: The desired name for the token. It will be displayed on the user account details. examples: - Your Client App Name type: string required: - email type: object responses: "200": content: application/json: schema: properties: securityCode: description: The code the user is going to receive on the email. **Must** be displayed to the user so they can verify the request is the correct. examples: - Practical Saola type: string token: description: The token used to verify the user accepted the login request examples: - T1dmvPu36nmyYisXAs7IRzcR type: string required: - token - securityCode type: object description: The request was successful and an email was sent "400": description: |- One of the provided values in the request body is invalid. The provided email is invalid because the owner is blocked security: [] summary: Login with email tags: - authentication /registration/verify: get: description: Verify the user accepted the login request and get a authentication token. The user email address and the token received after requesting the login must be added to the URL as a query string with the names `email` and `token`. operationId: verifyToken parameters: - description: Email to verify the login. in: query name: email required: false schema: description: Email to verify the login. type: string - description: The token returned when the login was requested. in: query name: token required: true schema: description: The token returned when the login was requested. type: string - description: The desired name for the token. It will be displayed on the user account details. in: query name: tokenName required: false schema: description: The desired name for the token. It will be displayed on the user account details. examples: - Your Client App Name type: string - description: The SAML Profile ID, when connecting a SAML Profile to a Team member for the first time. in: query name: ssoUserId required: false schema: description: The SAML Profile ID, when connecting a SAML Profile to a Team member for the first time. type: string responses: "200": content: application/json: schema: properties: email: description: Email address of the authenticated user. examples: - amy@example.com type: string teamId: description: When completing SAML Single Sign-On authentication, this will be the ID of the Team that was authenticated for. examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: string token: description: The user authentication token that can be used to perform API requests. examples: - 1ioXyz9Ue4xdCYGROet1dlKd type: string required: - token - email type: object description: The verification was successful. "400": description: |- One of the provided values in the request query is invalid. The provided token exists but is not yet confirmed "403": description: |- You do not have permission to access this resource. The verification sso token is invalid or not found The verification token is invalid or not found "404": description: "" security: [] summary: Verify a login request to get an authentication token tags: - authentication "/v1/deployments/{deploymentId}/checks": get: description: List all of the checks created for a deployment. operationId: getAllChecks parameters: - description: The deployment to get all checks for in: path name: deploymentId required: true schema: description: The deployment to get all checks for examples: - dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: checks: items: properties: completedAt: type: number conclusion: enum: - canceled - failed - neutral - succeeded - skipped - stale type: string createdAt: type: number detailsUrl: type: string id: type: string integrationId: type: string name: type: string output: properties: metrics: properties: CLS: properties: previousValue: type: number source: enum: - web-vitals type: string value: type: - number - "null" required: - value - source type: object FCP: properties: previousValue: type: number source: enum: - web-vitals type: string value: type: - number - "null" required: - value - source type: object LCP: properties: previousValue: type: number source: enum: - web-vitals type: string value: type: - number - "null" required: - value - source type: object TBT: properties: previousValue: type: number source: enum: - web-vitals type: string value: type: - number - "null" required: - value - source type: object virtualExperienceScore: properties: previousValue: type: number source: enum: - web-vitals type: string value: type: - number - "null" required: - value - source type: object required: - FCP - LCP - CLS - TBT type: object type: object path: type: string rerequestable: type: boolean startedAt: type: number status: enum: - registered - running - completed type: string updatedAt: type: number required: - createdAt - id - integrationId - name - rerequestable - status - updatedAt type: object type: array required: - checks type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The deployment was not found security: - bearerToken: [] summary: Retrieve a list of all checks tags: - checks post: description: Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error. operationId: createCheck parameters: - description: The deployment to create the check for. in: path name: deploymentId required: true schema: description: The deployment to create the check for. examples: - dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - 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: properties: blocking: description: Whether the check should block a deployment from succeeding examples: - true type: boolean detailsUrl: description: URL to display for further details examples: - http://example.com type: string externalId: description: An identifier that can be used as an external reference examples: - 1234abc type: string name: description: The name of the check being created examples: - Performance Check maxLength: 100 type: string path: description: Path of the page that is being checked examples: - / maxLength: 255 type: string rerequestable: description: Whether a user should be able to request for the check to be rerun if it fails examples: - true type: boolean required: - name - blocking type: object responses: "200": content: application/json: schema: description: Information for the SAML Single Sign-On configuration. properties: connectedAt: description: Timestamp (in milliseconds) of when the configuration was connected. examples: - 1611796915677 type: number lastReceivedWebhookEvent: description: Timestamp (in milliseconds) of when the last webhook event was received from WorkOS. examples: - 1611796915677 type: number state: description: Current state of the connection. examples: - active type: string status: description: Current status of the connection. examples: - linked type: string type: description: The Identity Provider "type", for example Okta. examples: - OktaSAML type: string required: - type - status - state - connectedAt type: object description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. Cannot create check for finished deployment The provided token is not from an OAuth2 Client "403": description: You do not have permission to access this resource. "404": description: The deployment was not found security: - bearerToken: [] summary: Creates a new Check tags: - checks "/v1/deployments/{deploymentId}/checks/{checkId}": get: description: Return a detailed response for a single check. operationId: getCheck parameters: - description: The deployment to get the check for. in: path name: deploymentId required: true schema: description: The deployment to get the check for. examples: - dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - description: The check to fetch in: path name: checkId required: true schema: description: The check to fetch examples: - check_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: description: From T, pick a set of properties whose keys are in the union K properties: createdAt: type: - number - "null" creator: type: string domain: type: string id: type: string name: type: string recordType: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string ttl: type: number type: enum: - record - record-sys type: string value: type: string required: - creator - domain - id - name - recordType - type - value type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: |- You do not have permission to access this resource. The provided token is not from an OAuth2 Client that created the Check "404": description: |- Check was not found The deployment was not found security: - bearerToken: [] summary: Get a single check tags: - checks patch: description: Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error. operationId: updateCheck parameters: - description: The deployment to update the check for. in: path name: deploymentId required: true schema: description: The deployment to update the check for. examples: - dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - description: The check being updated in: path name: checkId required: true schema: description: The check being updated examples: - check_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - 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: properties: conclusion: description: The result of the check being run enum: - canceled - failed - neutral - succeeded - skipped detailsUrl: description: A URL a user may visit to see more information about the check examples: - https://example.com/check/run/1234abc type: string externalId: description: An identifier that can be used as an external reference examples: - 1234abc type: string name: description: The name of the check being created examples: - Performance Check maxLength: 100 type: string output: description: The results of the check Run properties: metrics: additionalProperties: false description: Metrics about the page properties: CLS: properties: previousValue: description: Previous Cumulative Layout Shift value to display a delta examples: - 2 type: number source: enum: - web-vitals type: string value: description: Cumulative Layout Shift value examples: - 4 type: - number - "null" required: - value - source type: object FCP: properties: previousValue: description: Previous First Contentful Paint value to display a delta examples: - 900 type: number source: enum: - web-vitals type: string value: description: First Contentful Paint value examples: - 1200 type: - number - "null" required: - value - source type: object LCP: properties: previousValue: description: Previous Largest Contentful Paint value to display a delta examples: - 1000 type: number source: enum: - web-vitals type: string value: description: Largest Contentful Paint value examples: - 1200 type: - number - "null" required: - value - source type: object TBT: properties: previousValue: description: Previous Total Blocking Time value to display a delta examples: - 3500 type: number source: enum: - web-vitals value: description: Total Blocking Time value examples: - 3000 type: - number - "null" required: - value - source type: object virtualExperienceScore: properties: previousValue: description: A previous Virtual Experience Score value to display a delta, between 0 and 100 examples: - 35 maximum: 100 minimum: 0 type: integer source: enum: - web-vitals value: description: The calculated Virtual Experience Score value, between 0 and 100 examples: - 30 maximum: 100 minimum: 0 type: - integer - "null" required: - value - source type: object required: - FCP - LCP - CLS - TBT type: object type: object path: description: Path of the page that is being checked examples: - / maxLength: 255 type: string status: description: The current status of the check enum: - running - completed type: object responses: "200": content: application/json: schema: description: Information for the SAML Single Sign-On configuration. properties: connectedAt: description: Timestamp (in milliseconds) of when the configuration was connected. examples: - 1611796915677 type: number lastReceivedWebhookEvent: description: Timestamp (in milliseconds) of when the last webhook event was received from WorkOS. examples: - 1611796915677 type: number state: description: Current state of the connection. examples: - active type: string status: description: Current status of the connection. examples: - linked type: string type: description: The Identity Provider "type", for example Okta. examples: - OktaSAML type: string required: - type - status - state - connectedAt type: object description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The provided token is not from an OAuth2 Client "403": description: You do not have permission to access this resource. "404": description: |- Check was not found The deployment was not found "413": description: The output provided is too large security: - bearerToken: [] summary: Update a check tags: - checks "/v1/deployments/{deploymentId}/checks/{checkId}/rerequest": post: description: Rerequest a selected check that has failed. operationId: rerequestCheck parameters: - description: The deployment to rerun the check for. in: path name: deploymentId required: true schema: description: The deployment to rerun the check for. examples: - dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - description: The check to rerun in: path name: checkId required: true schema: description: The check to rerun examples: - check_2qn7PZrx89yxY34vEZPD31Y9XVj6 type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: |- The deployment was not found Check was not found security: - bearerToken: [] summary: Rerequest a check tags: - checks "/v1/domains/records/{recordId}": patch: description: Updates an existing DNS record for a domain name. operationId: updateRecord parameters: - description: The id of the DNS record in: path name: recordId required: true schema: description: The id of the DNS record examples: - rec_2qn7pzrx89yxy34vezpd31y9 type: string - 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: properties: additionalProperties: false mxPriority: description: The MX priority value of the DNS record type: - integer - "null" name: description: The name of the DNS record examples: - example-1 type: - string - "null" srv: additionalProperties: false properties: port: description: "" type: - integer - "null" priority: description: "" type: - integer - "null" target: description: "" examples: - example2.com. maxLength: 255 type: - string - "null" weight: description: "" type: - integer - "null" required: - target - weight - port - priority type: - object - "null" ttl: description: The Time to live (TTL) value of the DNS record examples: - "60" maximum: 2147483647 minimum: 60 type: - integer - "null" type: description: The type of the DNS record enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS examples: - A maxLength: 255 type: - string - "null" value: description: The value of the DNS record examples: - google.com type: - string - "null" type: object responses: "200": content: application/json: schema: description: From T, pick a set of properties whose keys are in the union K properties: createdAt: type: - number - "null" creator: type: string domain: type: string id: type: string name: type: string recordType: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string ttl: type: number type: enum: - record - record-sys type: string value: type: string required: - creator - domain - id - name - recordType - type - value type: object description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "401": description: "" "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" "409": description: "" security: - bearerToken: [] summary: Update an existing DNS record tags: - dns /v1/edge-config: get: description: Returns all Edge Configs. operationId: getEdgeConfigs parameters: - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: description: List of all edge configs. properties: createdAt: type: - number - "null" creator: type: string domain: type: string id: type: string itemCount: type: number name: type: string recordType: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string sizeInBytes: type: number ttl: type: number type: enum: - record - record-sys type: string value: type: string required: - sizeInBytes - itemCount type: object description: List of all edge configs. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Get Edge Configs tags: - edge-config post: description: Creates an Edge Config. operationId: createEdgeConfig parameters: - 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: properties: items: additionalProperties: oneOf: - oneOf: - type: string - type: number - type: boolean - type: "null" - type: object - items: oneOf: - type: string - type: number - type: boolean - type: "null" - type: object type: array propertyNames: maxLength: 256 pattern: ^[\\w-]+$ type: string type: object slug: maxLength: 32 pattern: ^[\\w-]+$ type: string required: - slug type: object responses: "201": content: application/json: schema: description: An Edge Config properties: connectedAt: description: Timestamp (in milliseconds) of when the configuration was connected. examples: - 1611796915677 type: number itemCount: type: number lastReceivedWebhookEvent: description: Timestamp (in milliseconds) of when the last webhook event was received from WorkOS. examples: - 1611796915677 type: number sizeInBytes: type: number state: description: Current state of the connection. examples: - active type: string status: description: Current status of the connection. examples: - linked type: string type: description: The Identity Provider "type", for example Okta. examples: - OktaSAML type: string required: - sizeInBytes - itemCount type: object description: "" "400": description: One of the provided values in the request body is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Create an Edge Config tags: - edge-config "/v1/edge-config/{edgeConfigId}": delete: description: Delete an Edge Config by id. operationId: deleteEdgeConfig parameters: - in: path name: edgeConfigId required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "204": description: "" "400": description: One of the provided values in the request query is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Delete an Edge Config tags: - edge-config get: description: Returns an Edge Config. operationId: getEdgeConfig parameters: - in: path name: edgeConfigId required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: description: The EdgeConfig. properties: createdAt: type: - number - "null" creator: type: string domain: type: string id: type: string itemCount: type: number name: type: string recordType: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string sizeInBytes: type: number ttl: type: number type: enum: - record - record-sys type: string value: type: string required: - sizeInBytes - itemCount type: object description: The EdgeConfig. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get an Edge Config tags: - edge-config put: description: Updates an Edge Config. operationId: updateEdgeConfig parameters: - in: path name: edgeConfigId required: true schema: type: string - 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: properties: slug: maxLength: 32 pattern: ^[\\w-]+$ type: string required: - slug type: object responses: "200": content: application/json: schema: description: An Edge Config properties: connectedAt: description: Timestamp (in milliseconds) of when the configuration was connected. examples: - 1611796915677 type: number itemCount: type: number lastReceivedWebhookEvent: description: Timestamp (in milliseconds) of when the last webhook event was received from WorkOS. examples: - 1611796915677 type: number sizeInBytes: type: number state: description: Current state of the connection. examples: - active type: string status: description: Current status of the connection. examples: - linked type: string type: description: The Identity Provider "type", for example Okta. examples: - OktaSAML type: string required: - sizeInBytes - itemCount type: object description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Update an Edge Config tags: - edge-config "/v1/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}": get: description: Returns a specific Edge Config Item. operationId: getEdgeConfigItem parameters: - in: path name: edgeConfigId required: true schema: type: string - in: path name: edgeConfigItemKey required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/EdgeConfigItem" description: The EdgeConfig. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get an Edge Config item tags: - edge-config "/v1/edge-config/{edgeConfigId}/items": get: description: Returns all items of an Edge Config. operationId: getEdgeConfigItems parameters: - in: path name: edgeConfigId required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/EdgeConfigItem" description: The EdgeConfig. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get Edge Config items tags: - edge-config patch: description: Update multiple Edge Config Items in batch. operationId: patchtEdgeConfigItems parameters: - in: path name: edgeConfigId required: true schema: type: string - 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: additionalProperties: false properties: items: items: oneOf: - properties: key: maxLength: 256 pattern: ^[\\w-]+$ type: string operation: oneOf: - const: create - const: update - const: upsert value: oneOf: - oneOf: - type: string - type: number - type: boolean - type: "null" - type: object - items: oneOf: - type: string - type: number - type: boolean - type: "null" - type: object type: array required: - operation - key - value type: object - properties: key: maxLength: 256 pattern: ^[\\w-]+$ type: string operation: const: delete required: - operation - key type: object type: array required: - items type: object responses: "200": content: application/json: schema: properties: status: type: string required: - status type: object description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" "409": description: "" security: - bearerToken: [] summary: Update Edge Config items in batch tags: - edge-config "/v1/edge-config/{edgeConfigId}/token": post: description: Adds a token to an existing Edge Config. operationId: createEdgeConfigToken parameters: - in: path name: edgeConfigId required: true schema: type: string - 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: additionalProperties: false properties: label: maxLength: 52 type: string required: - label type: object responses: "201": content: application/json: schema: properties: id: type: string token: type: string required: - token - id type: object description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Create an Edge Config token tags: - edge-config "/v1/edge-config/{edgeConfigId}/token/{token}": get: description: Return meta data about an Edge Config token. operationId: getEdgeConfigToken parameters: - in: path name: edgeConfigId required: true schema: type: string - in: path name: token required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/EdgeConfigToken" description: The EdgeConfig. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get Edge Config token meta data tags: - edge-config "/v1/edge-config/{edgeConfigId}/tokens": delete: description: Deletes one or more tokens of an existing Edge Config. operationId: deleteEdgeConfigTokens parameters: - in: path name: edgeConfigId required: true schema: type: string - 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: additionalProperties: false properties: tokens: items: type: string type: array required: - tokens type: object responses: "204": description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Delete one or more Edge Config tokens tags: - edge-config get: description: Returns all tokens of an Edge Config. operationId: getEdgeConfigTokens parameters: - in: path name: edgeConfigId required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/EdgeConfigToken" description: The EdgeConfig. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get all tokens of an Edge Config tags: - edge-config "/v1/integrations/configuration/{id}": delete: description: Allows to remove the configuration with the `id` provided in the parameters. The configuration and all of its resources will be removed. This includes Webhooks, LogDrains and Project Env variables. operationId: deleteConfiguration parameters: - in: path name: id required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "204": description: The configuration was successfully removed "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The configuration was not found security: - bearerToken: [] summary: Delete an integration configuration tags: - integrations get: description: Allows to retrieve a the configuration with the provided id in case it exists. The authenticated user or team must be the owner of the config in order to access it. operationId: getConfiguration parameters: - description: ID of the configuration to check in: path name: id required: true schema: description: ID of the configuration to check examples: - icfg_cuwj0AdCdH3BwWT4LPijCC7t type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - description: Make all properties in T optional properties: completedAt: description: A timestamp that tells you when the configuration was installed successfully examples: - 1558531915505 type: number createdAt: description: A timestamp that tells you when the configuration was created examples: - 1558531915505 type: number deletedAt: description: A timestamp that tells you when the configuration was updated. examples: - 1558531915505 type: - number - "null" disabledAt: description: "A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team." examples: - 1558531915505 type: number id: description: The unique identifier of the configuration examples: - icfg_3bwCLgxL8qt5kjRLcv2Dit7F type: string integrationId: description: The unique identifier of the app the configuration was created for examples: - oac_xzpVzcUOgcB1nrVlirtKhbWV type: string oauthConfiguration: description: Will be truthy in those cases where the configuration was created to authorize a client through the OAuth2 flow. examples: - false type: boolean ownerId: description: The user or team ID that owns the configuration examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string projects: description: When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. examples: - - prj_xQxbutw1HpL6HLYPAzt5h75m8NjO items: type: string type: array removedLogDrainsAt: type: number removedProjectEnvsAt: type: number removedTokensAt: type: number removedWebhooksAt: type: number scopes: description: The resources that are allowed to be accessed by the configuration. examples: - - read:project - read-write:log-drain items: type: string type: array scopesQueue: items: properties: confirmedAt: type: number note: type: string requestedAt: type: number scopes: properties: added: items: enum: - read:integration-configuration - read-write:integration-configuration - read:deployment - read-write:deployment - read-write:deployment-check - read:project - read-write:project - read-write:project-env-vars - read-write:global-project-env-vars - read:team - read:user - read-write:log-drain - read:domain - read-write:domain - read-write:edge-config - read-write:otel-endpoint - read:monitoring type: string type: array upgraded: items: enum: - read:integration-configuration - read-write:integration-configuration - read:deployment - read-write:deployment - read-write:deployment-check - read:project - read-write:project - read-write:project-env-vars - read-write:global-project-env-vars - read:team - read:user - read-write:log-drain - read:domain - read-write:domain - read-write:edge-config - read-write:otel-endpoint - read:monitoring type: string type: array required: - added - upgraded type: object required: - scopes - note - requestedAt type: object type: array slug: description: The slug of the integration the configuration is created for. examples: - slack type: string source: description: Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. enum: - marketplace - deploy-button - oauth - external examples: - marketplace type: string teamId: description: When the configuration was created for a team, this will show the ID of the team. examples: - team_nLlpyC6RE1qxydlFKbrxDlud type: - string - "null" type: enum: - integration-configuration type: string updatedAt: description: A timestamp that tells you when the configuration was updated. examples: - 1558531915505 type: number userId: description: The ID of the user that created the configuration. examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string required: - createdAt - id - integrationId - ownerId - slug - type - updatedAt - userId - scopes type: object - properties: canConfigureOpenTelemetry: type: boolean completedAt: description: A timestamp that tells you when the configuration was installed successfully examples: - 1558531915505 type: number createdAt: description: A timestamp that tells you when the configuration was created examples: - 1558531915505 type: number disabledAt: description: "A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team." examples: - 1558531915505 type: number id: description: The unique identifier of the configuration examples: - icfg_3bwCLgxL8qt5kjRLcv2Dit7F type: string integrationId: description: The unique identifier of the app the configuration was created for examples: - oac_xzpVzcUOgcB1nrVlirtKhbWV type: string oauthConfiguration: description: Will be truthy in those cases where the configuration was created to authorize a client through the OAuth2 flow. examples: - false type: boolean ownerId: description: The user or team ID that owns the configuration examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string projectSelection: description: A string representing the permission for projects. Possible values are `all` or `selected`. enum: - selected - all examples: - all type: string projects: description: When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. examples: - - prj_xQxbutw1HpL6HLYPAzt5h75m8NjO items: type: string type: array scopes: description: The resources that are allowed to be accessed by the configuration. examples: - - read:project - read-write:log-drain items: type: string type: array slug: description: The slug of the integration the configuration is created for. examples: - slack type: string source: description: Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. enum: - marketplace - deploy-button - oauth - external examples: - marketplace type: string teamId: description: When the configuration was created for a team, this will show the ID of the team. examples: - team_nLlpyC6RE1qxydlFKbrxDlud type: - string - "null" updatedAt: description: A timestamp that tells you when the configuration was updated. examples: - 1558531915505 type: number userId: description: The ID of the user that created the configuration. examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string required: - projectSelection - createdAt - id - integrationId - ownerId - slug - updatedAt - userId - scopes type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The configuration was not found security: - bearerToken: [] summary: Retrieve an integration configuration tags: - integrations /v1/integrations/configurations: get: description: Allows to retrieve all configurations for an authenticated integration. When the `project` view is used, configurations generated for the authorization flow will be filtered out of the results. operationId: getConfigurations parameters: - in: query name: view required: true schema: enum: - account - project type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - items: description: Make all properties in T optional properties: completedAt: description: A timestamp that tells you when the configuration was installed successfully examples: - 1558531915505 type: number createdAt: description: A timestamp that tells you when the configuration was created examples: - 1558531915505 type: number deletedAt: description: A timestamp that tells you when the configuration was updated. examples: - 1558531915505 type: - number - "null" disabledAt: description: "A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team." examples: - 1558531915505 type: number id: description: The unique identifier of the configuration examples: - icfg_3bwCLgxL8qt5kjRLcv2Dit7F type: string integrationId: description: The unique identifier of the app the configuration was created for examples: - oac_xzpVzcUOgcB1nrVlirtKhbWV type: string oauthConfiguration: description: Will be truthy in those cases where the configuration was created to authorize a client through the OAuth2 flow. examples: - false type: boolean ownerId: description: The user or team ID that owns the configuration examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string projects: description: When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. examples: - - prj_xQxbutw1HpL6HLYPAzt5h75m8NjO items: type: string type: array removedLogDrainsAt: type: number removedProjectEnvsAt: type: number removedTokensAt: type: number removedWebhooksAt: type: number scopes: description: The resources that are allowed to be accessed by the configuration. examples: - - read:project - read-write:log-drain items: type: string type: array scopesQueue: items: properties: confirmedAt: type: number note: type: string requestedAt: type: number scopes: properties: added: items: enum: - read:integration-configuration - read-write:integration-configuration - read:deployment - read-write:deployment - read-write:deployment-check - read:project - read-write:project - read-write:project-env-vars - read-write:global-project-env-vars - read:team - read:user - read-write:log-drain - read:domain - read-write:domain - read-write:edge-config - read-write:otel-endpoint - read:monitoring type: string type: array upgraded: items: enum: - read:integration-configuration - read-write:integration-configuration - read:deployment - read-write:deployment - read-write:deployment-check - read:project - read-write:project - read-write:project-env-vars - read-write:global-project-env-vars - read:team - read:user - read-write:log-drain - read:domain - read-write:domain - read-write:edge-config - read-write:otel-endpoint - read:monitoring type: string type: array required: - added - upgraded type: object required: - scopes - note - requestedAt type: object type: array slug: description: The slug of the integration the configuration is created for. examples: - slack type: string source: description: Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. enum: - marketplace - deploy-button - oauth - external examples: - marketplace type: string teamId: description: When the configuration was created for a team, this will show the ID of the team. examples: - team_nLlpyC6RE1qxydlFKbrxDlud type: - string - "null" type: enum: - integration-configuration type: string updatedAt: description: A timestamp that tells you when the configuration was updated. examples: - 1558531915505 type: number userId: description: The ID of the user that created the configuration. examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string required: - createdAt - id - integrationId - ownerId - slug - type - updatedAt - userId - scopes type: object type: array - items: properties: completedAt: description: A timestamp that tells you when the configuration was installed successfully examples: - 1558531915505 type: number createdAt: description: A timestamp that tells you when the configuration was created examples: - 1558531915505 type: number deletedAt: description: A timestamp that tells you when the configuration was updated. examples: - 1558531915505 type: - number - "null" disabledAt: description: "A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team." examples: - 1558531915505 type: number id: description: The unique identifier of the configuration examples: - icfg_3bwCLgxL8qt5kjRLcv2Dit7F type: string integration: properties: assignedBetaLabelAt: type: number category: type: string flags: items: type: string type: array icon: type: string isLegacy: type: boolean name: type: string required: - name - icon - category - isLegacy type: object integrationId: description: The unique identifier of the app the configuration was created for examples: - oac_xzpVzcUOgcB1nrVlirtKhbWV type: string oauthConfiguration: description: Will be truthy in those cases where the configuration was created to authorize a client through the OAuth2 flow. examples: - false type: boolean ownerId: description: The user or team ID that owns the configuration examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string projects: description: When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access. examples: - - prj_xQxbutw1HpL6HLYPAzt5h75m8NjO items: type: string type: array removedLogDrainsAt: type: number removedProjectEnvsAt: type: number removedTokensAt: type: number removedWebhooksAt: type: number scopes: description: The resources that are allowed to be accessed by the configuration. examples: - - read:project - read-write:log-drain items: type: string type: array scopesQueue: items: properties: confirmedAt: type: number note: type: string requestedAt: type: number scopes: properties: added: items: enum: - read:integration-configuration - read-write:integration-configuration - read:deployment - read-write:deployment - read-write:deployment-check - read:project - read-write:project - read-write:project-env-vars - read-write:global-project-env-vars - read:team - read:user - read-write:log-drain - read:domain - read-write:domain - read-write:edge-config - read-write:otel-endpoint - read:monitoring type: string type: array upgraded: items: enum: - read:integration-configuration - read-write:integration-configuration - read:deployment - read-write:deployment - read-write:deployment-check - read:project - read-write:project - read-write:project-env-vars - read-write:global-project-env-vars - read:team - read:user - read-write:log-drain - read:domain - read-write:domain - read-write:edge-config - read-write:otel-endpoint - read:monitoring type: string type: array required: - added - upgraded type: object required: - scopes - note - requestedAt type: object type: array slug: description: The slug of the integration the configuration is created for. examples: - slack type: string source: description: Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics. enum: - marketplace - deploy-button - oauth - external examples: - marketplace type: string teamId: description: When the configuration was created for a team, this will show the ID of the team. examples: - team_nLlpyC6RE1qxydlFKbrxDlud type: - string - "null" type: enum: - integration-configuration type: string updatedAt: description: A timestamp that tells you when the configuration was updated. examples: - 1558531915505 type: number userId: description: The ID of the user that created the configuration. examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string required: - integration - createdAt - id - integrationId - ownerId - slug - type - updatedAt - userId - scopes type: object type: array description: The list of configurations for the authenticated user "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Get configurations for the authenticated user or team tags: - integrations /v1/integrations/git-namespaces: get: description: Lists git namespaces for a supported provider. Supported providers are `github`, `gitlab` and `bitbucket`. If the provider is not provided, it will try to obtain it from the user that authenticated the request. operationId: gitNamespaces parameters: - in: query name: provider schema: enum: - github - gitlab - bitbucket - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: items: properties: id: oneOf: - type: string - type: number name: type: string ownerType: type: string provider: type: string slug: type: string required: - provider - slug - id - ownerType type: object type: array description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: List git namespaces by provider tags: - integrations "/v1/integrations/log-drains/{id}": delete: description: Deletes the Integration log drain with the provided `id`. When using an OAuth2 Token, the log drain can be deleted only if the integration owns it. operationId: deleteIntegrationLogDrain parameters: - description: ID of the log drain to be deleted in: path name: id required: true schema: description: ID of the log drain to be deleted type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "204": description: The log drain was successfully deleted "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The log drain was not found security: - bearerToken: [] summary: Deletes the Integration log drain with the provided `id` tags: - logDrains /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. parameters: - in: query name: query schema: type: string - in: query name: namespaceId schema: type: - string - number - "null" - in: query name: provider schema: enum: - github - gitlab - bitbucket - in: query name: installationId schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: gitAccount: properties: namespaceId: oneOf: - type: string - type: number type: "null" provider: enum: - github - gitlab - bitbucket type: string required: - provider - namespaceId type: object repos: items: properties: defaultBranch: type: string id: oneOf: - type: string - type: number name: type: string namespace: type: string ownerType: enum: - team - user type: string private: type: boolean slug: type: string updatedAt: type: number url: type: string required: - id - name - slug - namespace - private - defaultBranch - url - updatedAt - ownerType type: object type: array required: - gitAccount - repos type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: List git repositories linked to namespace by provider tags: - integrations /v1/log-drains: get: description: Retrieves a list of Configurable Log Drains. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed. operationId: getConfigurableLogDrains parameters: - in: query name: projectId schema: pattern: ^[a-zA-z0-9_]+$ type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: items: properties: branch: description: The branch to filter logs by examples: - main type: string configurationId: description: The ID of the related integration configuration type: string createdAt: description: A number containing the date when the log-drain was created in in milliseconds examples: - 1567024758130 type: number deliveryFormat: description: The log-drain defined delivery format enum: - json - ndjson - syslog examples: - - json - ndjson type: string environment: description: The environment to filter logs by enum: - preview - production examples: - production type: string headers: additionalProperties: type: string description: Construct a type with a set of properties K of type T examples: - foo: bar type: object id: description: The log-drain id examples: - ld_GflD6EYyo7F4ViYS type: string ownerId: description: The unique ID of the team the deployment belongs to examples: - team_ZspSRT4ljIEEmMHgoDwKWDei type: string projectIds: description: The ID of the projects the deployment is associated with examples: - - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB items: type: string type: array sources: description: The log-drain defined sources examples: - - lambda - build items: description: The log-drain defined sources enum: - static - lambda - build - edge - external - deployment examples: - - lambda - build type: string type: array url: description: A string with the URL of the log-drain examples: - https://my-log-drain.com type: string required: - createdAt - id - ownerId - deliveryFormat - url type: object type: array description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Retrieves a list of Configurable Log Drains tags: - logDrains post: description: Creates a configurable log drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed) operationId: createConfigurableLogDrain parameters: - 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: additionalProperties: false properties: branch: description: The branch regexp of log drain examples: - feature/* type: string deliveryFormat: description: The delivery log format enum: - json - ndjson examples: - json environment: description: The environment of log drain enum: - preview - production examples: - production headers: additionalProperties: type: string description: Headers to be sent together with the request type: object projectIds: items: pattern: ^[a-zA-z0-9_]+$ type: string maxItems: 50 minItems: 1 type: array sources: items: enum: - static - lambda - build - edge - external type: string minItems: 1 type: array uniqueItems: true url: description: The log drain url format: uri pattern: ^(http|https)?:// type: string required: - deliveryFormat - url - sources type: object responses: "200": content: application/json: schema: properties: branch: description: The branch to filter logs by examples: - main type: string configurationId: description: The ID of the related integration configuration type: string createdAt: description: A number containing the date when the log-drain was created in in milliseconds examples: - 1567024758130 type: number deliveryFormat: description: The log-drain defined delivery format enum: - json - ndjson - syslog examples: - - json - ndjson type: string environment: description: The environment to filter logs by enum: - preview - production examples: - production type: string headers: additionalProperties: type: string description: Construct a type with a set of properties K of type T examples: - foo: bar type: object id: description: The log-drain id examples: - ld_GflD6EYyo7F4ViYS type: string ownerId: description: The unique ID of the team the deployment belongs to examples: - team_ZspSRT4ljIEEmMHgoDwKWDei type: string projectIds: description: The ID of the projects the deployment is associated with examples: - - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB items: type: string type: array secret: description: The secret to validate the log-drain payload type: string sources: description: The log-drain defined sources examples: - - lambda - build items: description: The log-drain defined sources enum: - static - lambda - build - edge - external - deployment examples: - - lambda - build type: string type: array url: description: A string with the URL of the log-drain examples: - https://my-log-drain.com type: string required: - createdAt - id - ownerId - deliveryFormat - url type: object description: "" "400": description: One of the provided values in the request body is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Creates a Configurable Log Drain tags: - logDrains "/v1/log-drains/{id}": delete: description: Deletes a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be deleted. operationId: deleteConfigurableLogDrain parameters: - in: path name: id required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "204": description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Deletes a Configurable Log Drain tags: - logDrains get: description: Retrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken (integration OAuth2 clients are not allowed). Only log drains owned by the authenticated team can be accessed. operationId: getConfigurableLogDrain parameters: - in: path name: id required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: branch: description: The branch to filter logs by examples: - main type: string configurationId: description: The ID of the related integration configuration type: string createdAt: description: A number containing the date when the log-drain was created in in milliseconds examples: - 1567024758130 type: number deliveryFormat: description: The log-drain defined delivery format enum: - json - ndjson - syslog examples: - - json - ndjson type: string environment: description: The environment to filter logs by enum: - preview - production examples: - production type: string headers: additionalProperties: type: string description: Construct a type with a set of properties K of type T examples: - foo: bar type: object id: description: The log-drain id examples: - ld_GflD6EYyo7F4ViYS type: string ownerId: description: The unique ID of the team the deployment belongs to examples: - team_ZspSRT4ljIEEmMHgoDwKWDei type: string projectIds: description: The ID of the projects the deployment is associated with examples: - - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB items: type: string type: array sources: description: The log-drain defined sources examples: - - lambda - build items: description: The log-drain defined sources enum: - static - lambda - build - edge - external - deployment examples: - - lambda - build type: string type: array url: description: A string with the URL of the log-drain examples: - https://my-log-drain.com type: string required: - createdAt - id - ownerId - deliveryFormat - url type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Retrieves a Configurable Log Drain tags: - logDrains "/v1/projects/{idOrName}/env/{id}": get: description: Retrieve the environment variable for a given project. operationId: getProjectEnv parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA type: string - description: The unique ID for the environment variable to get the decrypted value. in: path name: id required: true schema: description: The unique ID for the environment variable to get the decrypted value. type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The project could not be found security: - bearerToken: [] summary: Retrieve the decrypted value of an environment variable of a project by id tags: - projects /v1/teams: post: description: Create a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name. operationId: createTeam parameters: [] requestBody: content: application/json: schema: additionalProperties: false properties: name: description: The desired name for the Team. It will be generated from the provided slug if nothing is provided examples: - A Random Team maxLength: 256 type: string slug: description: The desired slug for the Team examples: - a-random-team maxLength: 48 type: string required: - slug type: object responses: "200": content: application/json: schema: description: The team was created successfuly properties: id: description: Id of the created team examples: - team_nLlpyC6RE1qxqglFKbrMxlud type: string required: - id type: object description: The team was created successfuly "400": description: |- One of the provided values in the request body is invalid. The slug is already in use "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Create a Team tags: - teams "/v1/teams/{teamId}": delete: description: Delete a team under your account. You need to send a `DELETE` request with the desired team `id`. An optional array of reasons for deletion may also be sent. operationId: deleteTeam parameters: - description: The Team identifier or slug to perform the request on behalf of. in: path name: teamId required: true schema: type: string requestBody: content: application/json: schema: additionalProperties: false properties: reasons: description: Optional array of objects that describe the reason why the team is being deleted. items: additionalProperties: false description: An object describing the reason why the team is being deleted. properties: description: description: Description of the reason why the team is being deleted. type: string slug: description: Idenitifier slug of the reason why the team is being deleted. type: string required: - slug - description type: object type: array type: object responses: "200": content: application/json: schema: description: The Team was successfuly deleted properties: id: description: The ID of the deleted Team examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: string required: - id type: object description: The Team was successfuly deleted "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "402": description: "" "403": description: |- You do not have permission to access this resource. The authenticated user can't access the team "404": description: The team was not found security: - bearerToken: [] summary: Delete a Team tags: - teams "/v1/teams/{teamId}/invites/{inviteId}": delete: description: Delete an active Team invite code. operationId: deleteTeamInviteCode parameters: - description: The Team invite code ID. in: path name: inviteId required: true schema: description: The Team invite code ID. examples: - 2wn2hudbr4chb1ecywo9dvzo7g9sscs6mzcz8htdde0txyom4l type: string - description: Automatically added in: path name: teamId required: true schema: type: string responses: "200": content: application/json: schema: properties: id: description: ID of the team. type: string required: - id type: object description: Successfully deleted Team invite code. "400": description: One of the provided values in the request query is invalid. "403": description: |- You do not have permission to access this resource. Invite managed by directory sync Not authorized to access this team. "404": description: |- Team invite code not found. No team found. security: - bearerToken: [] summary: Delete a Team invite code tags: - teams "/v1/teams/{teamId}/members": post: description: Invite a user to join the team specified in the URL. The authenticated user needs to be an `OWNER` in order to successfully invoke this endpoint. The user can be specified with an email or an ID. If both email and ID are provided, ID will take priority. operationId: inviteUserToTeam parameters: - description: Automatically added in: path name: teamId required: true schema: type: string requestBody: content: application/json: schema: properties: email: description: The email address of the user to invite examples: - john@example.com format: email type: string role: {} uid: description: The id of the user to invite examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string type: object responses: "200": content: application/json: schema: oneOf: - description: The member was successfully added to the team properties: email: description: The email of the invited user. Not included if the user was invited via their UID. examples: - john@user.co type: string role: description: The role used for the invitation examples: - MEMBER type: string uid: description: The ID of the invited user examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string username: description: The username of the invited user examples: - john-doe type: string required: - uid - username - email - role type: object - properties: role: type: string uid: type: string username: type: string required: - uid - username - role type: object description: The member was successfully added to the team "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The user is already a team member The user already requested access to the team Hobby teams are not allowed to add seats. The team reached the maximum allowed amount of members "403": description: |- You do not have permission to access this resource. The authenticated user must be a team owner to perform the action "404": description: The team was not found security: - bearerToken: [] summary: Invite a user tags: - teams "/v1/teams/{teamId}/members/teams/join": post: description: Join a team with a provided invite code or team ID. operationId: joinTeam parameters: - description: Automatically added in: path name: teamId required: true schema: type: string requestBody: content: application/json: schema: properties: inviteCode: description: The invite code to join the team. examples: - fisdh38aejkeivn34nslfore9vjtn4ls type: string teamId: description: The team ID. examples: - team_3oNwMKqLHqEBh02CTPsrbNbe type: string type: object responses: "200": content: application/json: schema: description: Successfully joined a team. properties: from: description: The origin of how the user joined. examples: - email type: string name: description: The name of the team the user joined. examples: - My Team type: string slug: description: The slug of the team the user joined. examples: - my-team type: string teamId: description: The ID of the team the user joined. examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: string required: - teamId - slug - name - from type: object description: Successfully joined a team. "400": description: |- One of the provided values in the request body is invalid. Reached the max. amount of team members. "401": description: "" "402": description: "" "403": description: You do not have permission to access this resource. "404": description: Team not found. security: - bearerToken: [] summary: Join a team tags: - teams "/v1/teams/{teamId}/members/{uid}": delete: description: Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team. operationId: removeTeamMember parameters: - description: The user ID of the member. in: path name: uid required: true schema: description: The user ID of the member. examples: - ndlgr43fadlPyCtREAqxxdyFK type: string - description: Automatically added in: path name: teamId required: true schema: type: string responses: "200": content: application/json: schema: properties: id: description: ID of the team. type: string required: - id type: object description: Successfully removed a member of the team. "400": description: |- One of the provided values in the request query is invalid. Cannot leave the team as the only owner. "403": description: |- You do not have permission to access this resource. Not authorized to update the team. "404": description: |- A user with the specified ID does not exist. No team found. security: - bearerToken: [] summary: Remove a Team Member tags: - teams patch: description: Update the membership of a Team Member on the Team specified by `teamId`, such as changing the _role_ of the member, or confirming a request to join the Team for an unconfirmed member. The authenticated user must be an `OWNER` of the Team. operationId: updateTeamMember parameters: - description: The ID of the member. in: path name: uid required: true schema: description: The ID of the member. examples: - ndfasllgPyCtREAqxxdyFKb type: string - description: Automatically added in: path name: teamId required: true schema: type: string requestBody: content: application/json: schema: properties: confirmed: description: Accept a user who requested access to the team. enum: - true examples: - true type: boolean joinedFrom: additionalProperties: false properties: ssoUserId: type: "null" type: object role: default: - MEMBER - VIEWER description: The role in the team of the member. examples: - - MEMBER - VIEWER type: string type: object responses: "200": content: application/json: schema: properties: id: description: ID of the team. type: string required: - id type: object description: Successfully updated the membership. "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. Cannot disconnect SSO from a Team member that does not have a SSO connection. Cannot confirm a member that is already confirmed. Cannot confirm a member that did not request access. "401": description: Team members can only be updated by an owner, or by the authenticated user if they are only disconnecting their SAML connection to the Team. "402": description: "" "403": description: You do not have permission to access this resource. "404": description: |- The provided user is not part of this team. A user with the specified ID does not exist. Team not found. security: - bearerToken: [] summary: Update a Team Member tags: - teams "/v1/teams/{teamId}/request": post: description: Request access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time. operationId: requestAccessToTeam parameters: - description: Automatically added in: path name: teamId required: true schema: type: string requestBody: content: application/json: schema: additionalProperties: false properties: joinedFrom: additionalProperties: false properties: commitId: description: The commit sha if the origin is a git provider. examples: - f498d25d8bd654b578716203be73084b31130cd7 type: string gitUserId: description: The ID of the Git account of the user who requests access. examples: - 103053343 oneOf: - type: string - type: number gitUserLogin: description: The login name for the Git account of the user who requests access. examples: - jane-doe type: string origin: description: The origin of the request. enum: - import - teams - github - gitlab - bitbucket - feedback - organization-teams examples: - github type: string repoId: description: The ID of the repository for the given Git provider. examples: - "67753070" type: string repoPath: description: The path to the repository for the given Git provider. examples: - jane-doe/example type: string required: - origin type: object required: - joinedFrom type: object responses: "200": content: application/json: schema: properties: accessRequestedAt: type: number bitbucket: properties: login: type: string type: - object - "null" confirmed: type: boolean github: properties: login: type: string type: - object - "null" gitlab: properties: login: type: string type: - object - "null" joinedFrom: properties: commitId: type: string dsyncConnectedAt: type: number dsyncUserId: type: string gitUserId: oneOf: - type: string - type: number gitUserLogin: type: string idpUserId: type: string origin: enum: - import - teams - github - gitlab - bitbucket - feedback - organization-teams - mail - link - saml - dsync type: string repoId: type: string repoPath: type: string ssoConnectedAt: type: number ssoUserId: type: string required: - origin type: object teamName: type: string teamSlug: type: string required: - teamSlug - teamName - github - gitlab - bitbucket type: object description: Successfuly requested access to the team. "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "401": description: "" "403": description: You do not have permission to access this resource. "404": description: The team was not found. security: - bearerToken: [] summary: Request access to a team tags: - teams "/v1/teams/{teamId}/request/{userId}": get: description: Check the status of a join request. It'll respond with a 404 if the request has been declined. If no `userId` path segment was provided, this endpoint will instead return the status of the authenticated user. operationId: getTeamAccessRequest parameters: - in: path name: userId required: true schema: type: string - description: Automatically added in: path name: teamId required: true schema: type: string responses: "200": content: application/json: schema: properties: accessRequestedAt: description: Timestamp in milliseconds when the user requested access to the team. examples: - 1588720733602 type: number bitbucket: description: Map of the connected Bitbucket account. properties: login: type: string type: - object - "null" confirmed: description: Current status of the membership. Will be `true` if confirmed, if pending it'll be `false`. examples: - false type: boolean github: description: Map of the connected GitHub account. properties: login: type: string type: - object - "null" gitlab: description: Map of the connected GitLab account. properties: login: type: string type: - object - "null" joinedFrom: description: A map that describes the origin from where the user joined. properties: commitId: type: string dsyncConnectedAt: type: number dsyncUserId: type: string gitUserId: oneOf: - type: string - type: number gitUserLogin: type: string idpUserId: type: string origin: enum: - import - mail - link - teams - github - gitlab - bitbucket - saml - dsync - feedback - organization-teams type: string repoId: type: string repoPath: type: string ssoConnectedAt: type: number ssoUserId: type: string required: - origin type: object teamName: description: The name of the team. examples: - My Team type: string teamSlug: description: The slug of the team. examples: - my-team type: string required: - teamSlug - teamName - confirmed - joinedFrom - accessRequestedAt - github - gitlab - bitbucket type: object description: Successfully "400": description: |- One of the provided values in the request query is invalid. User is already a confirmed member of the team and did not request access. Only visible when the authenticated user does have access to the team. "403": description: You do not have permission to access this resource. "404": description: |- The provided user doesn't have a membership. Team was not found. security: - bearerToken: [] summary: Get access request status tags: - teams /v1/user: delete: description: Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process. operationId: requestDelete parameters: [] requestBody: content: application/json: schema: additionalProperties: false properties: reasons: description: Optional array of objects that describe the reason why the User account is being deleted. items: additionalProperties: false description: An object describing the reason why the User account is being deleted. properties: description: description: Description of the reason why the User account is being deleted. type: string slug: description: Idenitifier slug of the reason why the User account is being deleted. type: string required: - slug - description type: object type: array type: object responses: "202": content: application/json: schema: properties: email: description: Email address of the User who has initiated deletion. type: string id: description: Unique identifier of the User who has initiated deletion. type: string message: description: User deletion progress status. examples: - Verification email sent type: string required: - id - email - message type: object description: Response indicating that the User deletion process has been initiated, and a confirmation email has been sent. "400": description: One of the provided values in the request body is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Delete User Account tags: - user /v1/webhooks: get: description: Get a list of webhooks operationId: getWebhooks parameters: - in: query name: projectId schema: pattern: ^[a-zA-z0-9_]+$ type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - items: properties: createdAt: description: A number containing the date when the webhook was created in in milliseconds examples: - 1567024758130 type: number events: description: The webhooks events examples: - deployment.created items: description: The webhooks events enum: - domain.created - deployment.created - deployment.error - deployment.canceled - deployment.succeeded - deployment.ready - deployment.check-rerequested - integration-configuration.permission-upgraded - integration-configuration.removed - integration-configuration.scope-change-confirmed - project.created - project.removed - deployment-checks-completed - deployment-ready - deployment-prepared - deployment-error - deployment-check-rerequested - deployment-canceled - project-created - project-removed - domain-created - deployment - integration-configuration-permission-updated - integration-configuration-removed - integration-configuration-scope-change-confirmed examples: - deployment.created type: string type: array id: description: The webhook id examples: - account_hook_GflD6EYyo7F4ViYS type: string ownerId: description: The unique ID of the team the webhook belongs to examples: - ZspSRT4ljIEEmMHgoDwKWDei type: string projectIds: description: The ID of the projects the webhook is associated with examples: - - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB items: type: string type: array projectsMetadata: items: properties: framework: enum: - 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 type: - string - "null" id: type: string latestDeployment: type: string name: type: string required: - id - name type: object type: - array - "null" updatedAt: description: A number containing the date when the webhook was updated in in milliseconds examples: - 1567024758130 type: number url: description: A string with the URL of the webhook examples: - https://my-webhook.com type: string required: - projectsMetadata - events - id - url - ownerId - createdAt - updatedAt type: object type: array - items: properties: createdAt: description: A number containing the date when the webhook was created in in milliseconds examples: - 1567024758130 type: number events: description: The webhooks events examples: - deployment.created items: description: The webhooks events enum: - domain.created - deployment.created - deployment.error - deployment.canceled - deployment.succeeded - deployment.ready - deployment.check-rerequested - integration-configuration.permission-upgraded - integration-configuration.removed - integration-configuration.scope-change-confirmed - project.created - project.removed - deployment-checks-completed - deployment-ready - deployment-prepared - deployment-error - deployment-check-rerequested - deployment-canceled - project-created - project-removed - domain-created - deployment - integration-configuration-permission-updated - integration-configuration-removed - integration-configuration-scope-change-confirmed examples: - deployment.created type: string type: array id: description: The webhook id examples: - account_hook_GflD6EYyo7F4ViYS type: string ownerId: description: The unique ID of the team the webhook belongs to examples: - ZspSRT4ljIEEmMHgoDwKWDei type: string projectIds: description: The ID of the projects the webhook is associated with examples: - - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB items: type: string type: array updatedAt: description: A number containing the date when the webhook was updated in in milliseconds examples: - 1567024758130 type: number url: description: A string with the URL of the webhook examples: - https://my-webhook.com type: string required: - events - id - url - ownerId - createdAt - updatedAt type: object type: array description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Get a list of webhooks tags: - webhooks post: description: Creates a webhook operationId: createWebhook parameters: - 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: additionalProperties: false properties: events: items: enum: - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.DomainCreate - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.DeploymentCreate - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.DeploymentErro - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.DeploymentCancele - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.DeploymentSucceede - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.DeploymentRead - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.DeploymentCheckRerequeste - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.IntegrationConfigurationPermissionUpgrade - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.IntegrationConfigurationRemove - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.IntegrationConfigurationScopeChangeConfirme - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.ProjectCreate - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.ProjectRemove - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDeploymentChecksComplete - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDeploymentRead - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDeploymentPrepare - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDeploymentErro - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDeploymentCheckRerequeste - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDeploymentCancele - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyProjectCreate - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyProjectRemove - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDomainCreate - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyDeploymen - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyIntegrationConfigurationPermissionUpdate - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyIntegrationConfigurationRemove - mport("/vercel/path0/utils/webhooks/webhooks/types").WebhookName.LegacyIntegrationConfigurationScopeChangeConfirme type: string minItems: 1 type: array projectIds: items: pattern: ^[a-zA-z0-9_]+$ type: string maxItems: 50 minItems: 1 type: array url: format: uri pattern: ^https?:// type: string required: - url - events type: object responses: "200": content: application/json: schema: properties: createdAt: description: A number containing the date when the webhook was created in in milliseconds examples: - 1567024758130 type: number events: description: The webhooks events examples: - deployment.created items: description: The webhooks events enum: - domain.created - deployment.created - deployment.error - deployment.canceled - deployment.succeeded - deployment.ready - deployment.check-rerequested - integration-configuration.permission-upgraded - integration-configuration.removed - integration-configuration.scope-change-confirmed - project.created - project.removed - deployment-checks-completed - deployment-ready - deployment-prepared - deployment-error - deployment-check-rerequested - deployment-canceled - project-created - project-removed - domain-created - deployment - integration-configuration-permission-updated - integration-configuration-removed - integration-configuration-scope-change-confirmed examples: - deployment.created type: string type: array id: description: The webhook id examples: - account_hook_GflD6EYyo7F4ViYS type: string ownerId: description: The unique ID of the team the webhook belongs to examples: - ZspSRT4ljIEEmMHgoDwKWDei type: string projectIds: description: The ID of the projects the webhook is associated with examples: - - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB items: type: string type: array secret: description: The webhook secret used to sign the payload type: string updatedAt: description: A number containing the date when the webhook was updated in in milliseconds examples: - 1567024758130 type: number url: description: A string with the URL of the webhook examples: - https://my-webhook.com type: string required: - secret - events - id - url - ownerId - createdAt - updatedAt type: object description: "" "400": description: One of the provided values in the request body is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Creates a webhook tags: - webhooks "/v1/webhooks/{id}": delete: description: Deletes a webhook operationId: deleteWebhook parameters: - in: path name: id required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "204": description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Deletes a webhook tags: - webhooks get: description: Get a webhook operationId: getWebhook parameters: - in: path name: id required: true schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: createdAt: description: A number containing the date when the webhook was created in in milliseconds examples: - 1567024758130 type: number events: description: The webhooks events examples: - deployment.created items: description: The webhooks events enum: - domain.created - deployment.created - deployment.error - deployment.canceled - deployment.succeeded - deployment.ready - deployment.check-rerequested - integration-configuration.permission-upgraded - integration-configuration.removed - integration-configuration.scope-change-confirmed - project.created - project.removed - deployment-checks-completed - deployment-ready - deployment-prepared - deployment-error - deployment-check-rerequested - deployment-canceled - project-created - project-removed - domain-created - deployment - integration-configuration-permission-updated - integration-configuration-removed - integration-configuration-scope-change-confirmed examples: - deployment.created type: string type: array id: description: The webhook id examples: - account_hook_GflD6EYyo7F4ViYS type: string ownerId: description: The unique ID of the team the webhook belongs to examples: - ZspSRT4ljIEEmMHgoDwKWDei type: string projectIds: description: The ID of the projects the webhook is associated with examples: - - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB items: type: string type: array updatedAt: description: A number containing the date when the webhook was updated in in milliseconds examples: - 1567024758130 type: number url: description: A string with the URL of the webhook examples: - https://my-webhook.com type: string required: - events - id - url - ownerId - createdAt - updatedAt type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get a webhook tags: - webhooks "/v10/projects/{idOrName}/domains": post: description: Add a domain to the project by passing its domain name and by specifying the project by either passing the project `id` or `name` in the URL. If the domain is not yet verified to be used on this project, the request will return `verified = false`, and the domain will need to be verified according to the `verification` challenge via `POST /projects/:idOrName/domains/:domain/verify`. If the domain already exists on the project, the request will fail with a `400` status code. operationId: addProjectDomain parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name type: string - 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: properties: gitBranch: description: Git branch to link the project domain examples: - null maxLength: 250 type: - string - "null" name: description: The project domain name examples: - www.example.com type: string redirect: description: Target destination domain for redirect examples: - foobar.com type: - string - "null" redirectStatusCode: description: Status code for domain redirect enum: - null - 301 - 302 - 307 - 308 examples: - 307 type: - integer - "null" required: - name type: object responses: "200": content: application/json: schema: properties: apexName: type: string createdAt: type: number gitBranch: type: - string - "null" name: type: string projectId: type: string redirect: type: - string - "null" redirectStatusCode: enum: - 307 - 301 - 302 - 308 type: - number - "null" updatedAt: type: number verification: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." items: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." properties: domain: type: string reason: type: string type: type: string value: type: string required: - type - domain - value - reason type: object type: array verified: description: "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed." type: boolean required: - name - apexName - projectId - verified type: object description: The domain was successfully added to the project "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The domain is not valid You can't set both a git branch and a redirect for the domain The domain can not be added because the latest production deployment for the project was not successful The domain redirect is not valid A domain cannot redirect to itself You can not set the production branch as a branch for your domain "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- You do not have permission to access this resource. You don't have access to the domain you are adding "404": description: Project not found "409": description: |- The domain is already assigned to another Vercel project Cannot create project domain since owner already has `domain` on their account Cannot create project domain if the current verified domain The project is currently being transferred security: - bearerToken: [] summary: Add a domain to a project tags: - projects "/v10/projects/{idOrName}/env": post: description: Create one ore more environment variables for a project by passing its `key`, `value`, `type` and `target` and by specifying the project by either passing the project `id` or `name` in the URL. operationId: createProjectEnv parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA type: string - description: Allow override of environment variable if it already exists in: query name: upsert required: false schema: description: Allow override of environment variable if it already exists examples: - "true" type: string - 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: oneOf: - properties: gitBranch: description: The git branch of the environment variable examples: - feature-1 maxLength: 250 type: - string - "null" key: description: The name of the environment variable examples: - API_URL type: string target: description: The target environment of the environment variable examples: - - production - preview items: enum: - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Productio - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Previe - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Developmen type: array type: description: The type of environment variable enum: - system - secret - encrypted - plain - sensitive examples: - plain type: string value: description: The value of the environment variable examples: - https://api.vercel.com type: string required: - key - value - type - target type: object - items: properties: gitBranch: description: The git branch of the environment variable examples: - feature-1 maxLength: 250 type: - string - "null" key: description: The name of the environment variable examples: - API_URL type: string target: description: The target environment of the environment variable examples: - - production - preview items: enum: - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Productio - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Previe - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Developmen type: array type: description: The type of environment variable enum: - system - secret - encrypted - plain - sensitive examples: - plain type: string value: description: The value of the environment variable examples: - https://api.vercel.com type: string required: - key - value - type - target type: object type: array responses: "201": content: application/json: schema: properties: created: oneOf: - properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string system: type: boolean target: oneOf: - items: enum: - production - preview - development - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string type: object - items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string system: type: boolean target: oneOf: - items: enum: - production - preview - development - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string type: object type: array failed: items: properties: error: properties: action: type: string code: type: string envVarId: type: string envVarKey: type: string gitBranch: type: string key: type: string link: type: string message: type: string project: type: string target: oneOf: - items: enum: - production - preview - development - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development - preview - development type: string value: oneOf: - type: string - items: enum: - production - preview - development - preview - development - preview - development type: string type: array required: - code - message type: object required: - error type: object type: array required: - created - failed type: object description: The environment variable was created successfully "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- You do not have permission to access this resource. The environment variable cannot be created because it already exists Additional permissions are required to create production environment variables "404": description: The project could not be found "409": description: The project is being transfered and creating an environment variable is not possible security: - bearerToken: [] summary: Create one or more environment variables tags: - projects "/v11/deployments/{deploymentId}/builds": get: description: Retrieves the list of builds given their deployment's unique identifier. operationId: listDeploymentBuilds parameters: - description: The deployment unique identifier in: path name: deploymentId required: true schema: description: The deployment unique identifier type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: builds: items: description: An object representing a Build on Vercel properties: config: description: An object that contains the Build's configuration examples: - zeroConfig: true properties: distDir: type: string forceBuildIn: type: string reuseWorkPathFrom: type: string zeroConfig: type: boolean type: object copiedFrom: type: string createdAt: description: The time at which the Build was created examples: - 1567071524208 type: number createdIn: description: The region where the Build was first created examples: - sfo1 type: string deployedAt: description: The time at which the Build was deployed examples: - 1567071598563 type: number deploymentId: description: The unique identifier of the deployment examples: - dpl_BRGyoU2Jzzwx7myBnqv3xjRDD2GnHTwUWyFybnrUvjDD type: string entrypoint: description: The entrypoint of the deployment examples: - api/index.js type: string fingerprint: description: If the Build uses the `@vercel/static` Runtime, it contains a hashed string of all outputs examples: - null type: - string - "null" id: description: The unique identifier of the Build examples: - bld_q5fj68jh7eewfe8 type: string output: description: A list of outputs for the Build that can be either Serverless Functions or static files items: description: A list of outputs for the Build that can be either Serverless Functions or static files properties: digest: description: The SHA1 of the file type: string edge: description: Exists if the output is an edge function. properties: regions: description: "The regions where the edge function will be invoked. Only exists if the edge function as a regional edge function, see: https://vercel.com/docs/concepts/edge-network/regions#setting-edge-function-regions" items: type: string type: - array - "null" required: - regions type: - object - "null" lambda: description: If the output is a Serverless Function, an object containing the name, location and memory size of the function properties: deployedTo: items: type: string type: array functionName: type: string layers: items: type: string type: array memorySize: type: number timeout: type: number required: - functionName - deployedTo type: - object - "null" mode: description: The POSIX file permissions type: number path: description: The absolute path of the file or Serverless Function type: string size: description: The size of the file in bytes type: number type: description: The type of the output enum: - lambda - file - edge type: string required: - path - digest - mode type: object type: array readyState: description: The state of the deployment depending on the process of deploying, or if it is ready or in an error state enum: - BUILDING - ERROR - INITIALIZING - QUEUED - READY - CANCELED - UPLOADING - DEPLOYING - ARCHIVED examples: - READY type: string readyStateAt: description: The time at which the Build state was last modified examples: - 1567024758130 type: number scheduledAt: description: The time at which the Build was scheduled to be built examples: - 1567024756543 type: - number - "null" use: description: The Runtime the Build used to generate the output examples: - "@vercel/node" type: string required: - id - deploymentId - entrypoint - readyState - output type: object type: array required: - builds type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: Deployment was not found security: - bearerToken: [] summary: List Deployment Builds tags: - deployments "/v12/deployments/{id}/cancel": patch: description: This endpoint allows you to cancel a deployment which is currently building, by supplying its `id` in the URL. operationId: cancelDeployment parameters: - description: The unique identifier of the deployment. in: path name: id required: true schema: description: The unique identifier of the deployment. examples: - dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: alias: description: A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation examples: - [] items: type: string type: array aliasAssigned: description: A boolean that will be true when the aliases from the alias property were assigned successfully examples: - true type: boolean aliasAssignedAt: oneOf: - type: number - type: boolean type: "null" aliasError: description: An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` examples: - null properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" aliasWarning: properties: action: type: string code: type: string link: type: string message: type: string required: - code - message type: - object - "null" automaticAliases: items: type: string type: array bootedAt: type: number build: properties: env: description: The keys of the environment variables that were assigned during the build phase. examples: - - MY_ENV_VAR items: type: string type: array required: - env type: object buildErrorAt: type: number buildingAt: type: number builds: items: properties: config: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object src: type: string use: type: string required: - use type: object type: array canceledAt: type: number checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: description: The ID of Vercel Connect configuration used for this deployment type: string createdAt: description: A number containing the date when the deployment was created in milliseconds examples: - 1540257589405 type: number createdIn: description: The region where the deployment was first created examples: - sfo1 type: string creator: description: Information about the deployment creator properties: uid: description: The ID of the user that created the deployment examples: - 96SnxkFiMyVKsK3pnoHfx3Hz type: string username: description: The username of the user that created the deployment examples: - john-doe type: string required: - uid type: object env: description: The keys of the environment variables that were assigned during runtime examples: - - MY_SECRET items: type: string type: array errorCode: type: string errorLink: type: string errorMessage: type: - string - "null" errorStep: type: string functions: additionalProperties: description: An object used to configure your Serverless Functions examples: - api/test.js: memory: 3008 properties: excludeFiles: type: string includeFiles: type: string maxDuration: type: number memory: type: number runtime: type: string type: object description: An object used to configure your Serverless Functions examples: - api/test.js: memory: 3008 type: - object - "null" gitRepo: oneOf: - properties: defaultBranch: type: string name: type: string namespace: type: string ownerType: enum: - user - team type: string path: type: string private: type: boolean projectId: type: number type: enum: - gitlab type: string url: type: string required: - namespace - projectId - type - url - path - defaultBranch - name - private - ownerType type: object - properties: defaultBranch: type: string name: type: string org: type: string ownerType: enum: - user - team type: string path: type: string private: type: boolean repo: type: string repoId: type: number repoOwnerId: type: string type: enum: - github type: string required: - org - repo - repoId - type - repoOwnerId - path - defaultBranch - name - private - ownerType type: object - properties: defaultBranch: type: string name: type: string owner: type: string ownerType: enum: - user - team type: string path: type: string private: type: boolean repoUuid: type: string slug: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - owner - repoUuid - slug - type - workspaceUuid - path - defaultBranch - name - private - ownerType type: object type: "null" gitSource: oneOf: - properties: prId: type: - number - "null" ref: type: - string - "null" repoId: oneOf: - type: string - type: number sha: type: string type: enum: - github type: string required: - type - repoId type: object - properties: org: type: string prId: type: - number - "null" ref: type: - string - "null" repo: type: string sha: type: string type: enum: - github type: string required: - type - org - repo type: object - properties: prId: type: - number - "null" projectId: oneOf: - type: string - type: number ref: type: - string - "null" sha: type: string type: enum: - gitlab type: string required: - type - projectId type: object - properties: prId: type: - number - "null" ref: type: - string - "null" repoUuid: type: string sha: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - repoUuid type: object - properties: owner: type: string prId: type: - number - "null" ref: type: - string - "null" sha: type: string slug: type: string type: enum: - bitbucket type: string required: - type - owner - slug type: object - properties: gitUrl: type: string ref: type: string sha: type: string type: enum: - custom type: string required: - type - ref - sha - gitUrl type: object - properties: org: type: string ref: type: string repo: type: string repoId: type: number sha: type: string type: enum: - github type: string required: - type - ref - sha - repoId type: object - properties: projectId: type: number ref: type: string sha: type: string type: enum: - gitlab type: string required: - type - ref - sha - projectId type: object - properties: owner: type: string ref: type: string repoUuid: type: string sha: type: string slug: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - ref - sha - workspaceUuid - repoUuid type: object id: description: A string holding the unique ID of the deployment examples: - dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ type: string inspectorUrl: description: Vercel URL to inspect the deployment. examples: - https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq type: - string - "null" isInConcurrentBuildsQueue: description: Is the deployment currently queued waiting for a Concurrent Build Slot to be available examples: - false type: boolean lambdas: items: properties: createdAt: type: number entrypoint: type: - string - "null" id: type: string output: items: properties: functionName: type: string path: type: string required: - path - functionName type: object type: array readyState: enum: - INITIALIZING - BUILDING - READY - ERROR type: string readyStateAt: type: number required: - id - output type: object type: array meta: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object monorepoManager: description: An monorepo manager that was used for the deployment examples: - turbo type: - string - "null" name: description: The name of the project associated with the deployment at the time that the deployment was created examples: - my-project type: string ownerId: description: The unique ID of the user or team the deployment belongs to examples: - ZspSRT4ljIEEmMHgoDwKWDei type: string plan: description: The pricing plan the deployment was made under enum: - hobby - enterprise - pro - oss examples: - pro type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean projectId: description: The ID of the project the deployment is associated with examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string public: description: A boolean representing if the deployment is public or not. By default this is `false` examples: - false type: boolean readyState: description: The state of the deployment depending on the process of deploying, or if it is ready or in an error state enum: - INITIALIZING - BUILDING - READY - ERROR - QUEUED - CANCELED examples: - READY type: string regions: description: The regions the deployment exists in examples: - - sfo1 items: type: string type: array routes: description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs items: oneOf: - description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs properties: caseSensitive: type: boolean check: type: boolean continue: type: boolean dest: type: string has: items: oneOf: - properties: type: enum: - host type: string value: type: string required: - type - value type: object - properties: key: type: string type: enum: - header - cookie - query type: string value: type: string required: - type - key type: object type: array headers: additionalProperties: type: string type: object important: type: boolean locale: properties: cookie: type: string redirect: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object type: object methods: items: type: string type: array middleware: description: A middleware index in the `middleware` key under the build result type: number middlewarePath: description: A middleware key within the `output` key under the build result. Overrides a `middleware` definition. type: string middlewareRawSrc: description: The original middleware matchers. items: type: string type: array missing: items: oneOf: - properties: type: enum: - host type: string value: type: string required: - type - value type: object - properties: key: type: string type: enum: - header - cookie - query type: string value: type: string required: - type - key type: object type: array override: type: boolean src: type: string status: type: number required: - src type: object - description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs properties: dest: type: string handle: enum: - filesystem - hit - miss - rewrite - error - resource type: string src: 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 examples: - - dest: https://docs.example.com src: /docs properties: continue: type: boolean middleware: enum: - 0 type: number src: type: string required: - src - continue - middleware type: object type: - array - "null" source: description: Where was the deployment created from enum: - cli - git - import - import/repo - clone/repo examples: - cli type: string target: description: If defined, either `staging` if a staging alias in the format `..now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned enum: - staging - production examples: - null type: - string - "null" team: description: The team that owns the deployment if any properties: id: description: The ID of the team owner examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: string name: description: The name of the team owner examples: - FSociety type: string slug: description: The slug of the team owner examples: - fsociety type: string required: - id - name - slug type: object type: enum: - LAMBDAS type: string url: description: A string with the unique URL of the deployment examples: - my-instant-deployment-3ij3cxz9qr.now.sh type: string userAliases: description: An array of domains that were provided by the user when creating the Deployment. examples: - - sub1.example.com - sub2.example.com items: type: string type: array version: description: The platform version that was used to create the deployment. enum: - 2 examples: - 2 type: number required: - build - createdIn - env - inspectorUrl - isInConcurrentBuildsQueue - meta - name - ownerId - plan - projectId - routes - alias - aliasAssigned - bootedAt - buildingAt - createdAt - creator - id - public - readyState - regions - type - url - version type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Cancel a deployment tags: - deployments /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 parameters: - description: Forces a new deployment even if there is a previous similar deployment in: query name: forceNew schema: description: Forces a new deployment even if there is a previous similar deployment enum: - "0" - "1" - description: Allows to skip framework detection so the API would not fail to ask for confirmation in: query name: skipAutoDetectionConfirmation 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: additionalProperties: false properties: $schema: description: Ignored. Can be set to get completions, validations and documentation in some editors. examples: - - 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 examples: - - example.vercel.app items: maxLength: 253 type: string maxItems: 50 maxLength: 253 type: array build: additionalProperties: false deprecated: true description: An object containing another object with information to be passed to the Build Process properties: env: additionalProperties: maxLength: 65536 type: string deprecated: true 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 `@` examples: - A_SECRET: "@a-secret" maxProperties: 100 minProperties: 0 type: object type: object buildCommand: description: The build command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" builds: deprecated: true description: A list of build descriptions whose src references valid source files. 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 crons: description: An array of cron jobs that should be created for production Deployments. items: properties: path: maxLength: 512 pattern: ^/.* type: string schedule: maxLength: 256 type: string required: - schedule - path type: object maxItems: 20 type: array deploymentId: description: An deployment id for an existing deployment to redeploy type: string devCommand: description: The dev command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" env: additionalProperties: maxLength: 65536 type: string deprecated: true description: An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with `@` examples: - A_SECRET: "@a-secret" maxProperties: 100 minProperties: 0 type: object 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 examples: - 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 examples: - 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 framework: description: The framework that is being used for this project. When `null` is used no framework is selected 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 type: - string - "null" 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`). examples: - src/pages/**: maxDuration: 6 memory: 1024 maxProperties: 50 minProperties: 1 type: object git: 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. examples: - main: false oneOf: - type: boolean - additionalProperties: type: boolean type: object type: object gitMetadata: additionalProperties: false description: Populates initial git metadata for different git providers. properties: commitAuthorName: description: The name of the author of the commit examples: - kyliau type: string commitMessage: description: The commit message examples: - add method to measure Interaction to Next Paint (INP) (#36490) type: string commitRef: description: The branch on which the commit was made examples: - main type: string commitSha: description: The hash of the commit examples: - dc36199b2234c6586ebe05ec94078a895c707e29 type: string dirty: description: Whether or not there have been modifications to the working tree since the latest commit examples: - true type: boolean remoteUrl: description: The git repository's remote origin url examples: - https://github.com/vercel/next.js type: string type: object gitSource: 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 description: Defines the Git Repository source to be deployed. This property can not be used in combination with `files`. headers: description: A list of header definitions. items: additionalProperties: false properties: has: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array headers: description: An array of key/value pairs representing each response header. items: additionalProperties: false properties: key: maxLength: 4096 type: string value: maxLength: 4096 type: string required: - key - value type: object maxItems: 1024 type: array missing: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array source: description: A pattern that matches each incoming pathname (excluding querystring) maxLength: 4096 type: string required: - source - headers type: object maxItems: 1024 type: array ignoreCommand: maxLength: 256 type: - string - "null" images: additionalProperties: false properties: contentDispositionType: enum: - inline - attachment contentSecurityPolicy: maxLength: 256 type: string dangerouslyAllowSVG: type: boolean domains: items: maxLength: 256 type: string maxItems: 50 minItems: 0 type: array formats: items: enum: - image/avif - image/webp - image/jpeg - image/png maxItems: 4 minItems: 1 type: array minimumCacheTTL: maximum: 315360000 minimum: 1 type: integer remotePatterns: items: additionalProperties: false properties: hostname: maxLength: 256 type: string pathname: maxLength: 256 type: string port: maxLength: 5 type: string protocol: enum: - http - https required: - hostname type: object maxItems: 50 minItems: 0 type: array sizes: items: type: number maxItems: 50 minItems: 1 type: array required: - sizes type: object installCommand: description: The install command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" meta: additionalProperties: maxLength: 65536 type: string description: An object containing the deployment's metadata. Multiple key-value pairs can be attached to a deployment examples: - 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 - "null" name: description: A string with the project name used in the deployment URL examples: - my-instant-deployment type: string outputDirectory: description: The output directory of the project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" project: description: The target project identifier in which the deployment will be created. When defined, this parameter overrides name examples: - my-deployment-project type: string 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 - "null" commandForIgnoringBuildStep: maxLength: 256 type: - string - "null" devCommand: description: The dev command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" framework: description: The framework that is being used for this project. When `null` is used no framework is selected 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 type: - string - "null" installCommand: description: The install command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" outputDirectory: description: The output directory of the project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" 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 - "null" serverlessFunctionRegion: description: The region to deploy Serverless Functions in this project maxLength: 4 type: - string - "null" skipGitConnectDuringLink: deprecated: true description: Opts-out of the message prompting a CLI user to connect a Git repository in `vercel link`. type: boolean sourceFilesOutsideRootDirectory: description: Indicates if there are source files outside of the root directory, typically used for monorepos type: boolean type: object public: description: Whether a deployment's source and logs are available publicly type: boolean redirects: description: A list of redirect definitions. items: additionalProperties: false properties: destination: description: A location destination defined as an absolute pathname or external URL. maxLength: 4096 type: string has: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array missing: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array 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 source: description: A pattern that matches each incoming pathname (excluding querystring). maxLength: 4096 type: string required: - source - destination type: object maxItems: 1024 title: Redirects type: array regions: description: An array of the regions the deployment's Serverless Functions should be deployed to examples: - - sfo - bru items: maxLength: 256 type: string maxItems: 1000 minItems: 1 type: array rewrites: description: A list of rewrite definitions. items: additionalProperties: false properties: destination: description: An absolute pathname to an existing resource or an external URL. maxLength: 4096 type: string has: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array missing: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array source: description: A pattern that matches each incoming pathname (excluding querystring). maxLength: 4096 type: string required: - source - destination type: object maxItems: 1024 type: array routes: deprecated: true description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs items: anyOf: - additionalProperties: false properties: caseSensitive: type: boolean check: type: boolean continue: type: boolean dest: maxLength: 4096 type: string has: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array headers: additionalProperties: maxLength: 4096 type: string maxProperties: 100 minProperties: 1 type: object important: type: boolean isInternal: type: boolean locale: additionalProperties: false minProperties: 1 properties: cookie: maxLength: 4096 type: string default: maxLength: 4096 type: string path: maxLength: 4096 type: string redirect: additionalProperties: maxLength: 4096 type: string maxProperties: 100 minProperties: 1 type: object value: maxLength: 4096 type: string type: object methods: items: maxLength: 32 type: string maxItems: 10 type: array middleware: type: number middlewarePath: type: string middlewareRawSrc: items: type: string type: array missing: description: An array of requirements that are needed to match items: anyOf: - additionalProperties: false properties: type: description: The type of request element to check enum: - host type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - value type: object - additionalProperties: false properties: key: description: The name of the element contained in the particular type maxLength: 4096 type: string type: description: The type of request element to check enum: - header - cookie - query type: string value: description: A regular expression used to match the value. Named groups can be used in the destination maxLength: 4096 type: string required: - type - key type: object maxItems: 16 type: array override: type: boolean src: maxLength: 4096 type: string status: maximum: 999 minimum: 100 type: integer user: type: boolean required: - src type: object - additionalProperties: false properties: handle: enum: - error - filesystem - hit - miss - resource - rewrite maxLength: 32 type: string required: - handle type: object maxItems: 1024 type: array target: description: Either not defined, `staging`, or `production`. If `staging`, a staging alias in the format `-.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 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 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 required: - name type: object responses: "200": content: application/json: schema: description: The successfully created deployment properties: alias: description: A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation examples: - [] items: type: string type: array aliasAssigned: description: A boolean that will be true when the aliases from the alias property were assigned successfully examples: - true type: boolean aliasAssignedAt: oneOf: - type: number - type: boolean type: "null" aliasError: description: An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` examples: - null properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" aliasWarning: properties: action: type: string code: type: string link: type: string message: type: string required: - code - message type: - object - "null" automaticAliases: items: type: string type: array bootedAt: type: number build: properties: env: description: The keys of the environment variables that were assigned during the build phase. examples: - - MY_ENV_VAR items: type: string type: array required: - env type: object buildErrorAt: type: number buildingAt: type: number builds: items: type: object type: array canceledAt: type: number checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: description: The ID of Vercel Connect configuration used for this deployment type: string createdAt: description: A number containing the date when the deployment was created in milliseconds examples: - 1540257589405 type: number createdIn: description: The region where the deployment was first created examples: - sfo1 type: string creator: description: Information about the deployment creator properties: uid: description: The ID of the user that created the deployment examples: - 96SnxkFiMyVKsK3pnoHfx3Hz type: string username: description: The username of the user that created the deployment examples: - john-doe type: string required: - uid type: object env: description: The keys of the environment variables that were assigned during runtime examples: - - MY_SECRET items: type: string type: array errorCode: type: string errorLink: type: string errorMessage: type: - string - "null" errorStep: type: string functions: additionalProperties: description: An object used to configure your Serverless Functions examples: - api/test.js: memory: 3008 properties: excludeFiles: type: string includeFiles: type: string maxDuration: type: number memory: type: number runtime: type: string type: object description: An object used to configure your Serverless Functions examples: - api/test.js: memory: 3008 type: - object - "null" gitRepo: oneOf: - properties: defaultBranch: type: string name: type: string namespace: type: string ownerType: enum: - team - user type: string path: type: string private: type: boolean projectId: type: number type: enum: - gitlab type: string url: type: string required: - namespace - projectId - type - url - path - defaultBranch - name - private - ownerType type: object - properties: defaultBranch: type: string name: type: string org: type: string ownerType: enum: - team - user type: string path: type: string private: type: boolean repo: type: string repoId: type: number repoOwnerId: type: string type: enum: - github type: string required: - org - repo - repoId - type - repoOwnerId - path - defaultBranch - name - private - ownerType type: object - properties: defaultBranch: type: string name: type: string owner: type: string ownerType: enum: - team - user type: string path: type: string private: type: boolean repoUuid: type: string slug: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - owner - repoUuid - slug - type - workspaceUuid - path - defaultBranch - name - private - ownerType type: object type: "null" gitSource: oneOf: - properties: prId: type: - number - "null" ref: type: - string - "null" repoId: oneOf: - type: string - type: number sha: type: string type: enum: - github type: string required: - type - repoId type: object - properties: org: type: string prId: type: - number - "null" ref: type: - string - "null" repo: type: string sha: type: string type: enum: - github type: string required: - type - org - repo type: object - properties: prId: type: - number - "null" projectId: oneOf: - type: string - type: number ref: type: - string - "null" sha: type: string type: enum: - gitlab type: string required: - type - projectId type: object - properties: prId: type: - number - "null" ref: type: - string - "null" repoUuid: type: string sha: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - repoUuid type: object - properties: owner: type: string prId: type: - number - "null" ref: type: - string - "null" sha: type: string slug: type: string type: enum: - bitbucket type: string required: - type - owner - slug type: object - properties: gitUrl: type: string ref: type: string sha: type: string type: enum: - custom type: string required: - type - ref - sha - gitUrl type: object - properties: org: type: string ref: type: string repo: type: string repoId: type: number sha: type: string type: enum: - github type: string required: - type - ref - sha - repoId type: object - properties: projectId: type: number ref: type: string sha: type: string type: enum: - gitlab type: string required: - type - ref - sha - projectId type: object - properties: owner: type: string ref: type: string repoUuid: type: string sha: type: string slug: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - ref - sha - workspaceUuid - repoUuid type: object id: description: A string holding the unique ID of the deployment examples: - dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ type: string inspectorUrl: description: Vercel URL to inspect the deployment. examples: - https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq type: - string - "null" isInConcurrentBuildsQueue: description: Is the deployment currently queued waiting for a Concurrent Build Slot to be available examples: - false type: boolean lambdas: items: properties: createdAt: type: number entrypoint: type: - string - "null" id: type: string output: items: properties: functionName: type: string path: type: string required: - path - functionName type: object type: array readyState: enum: - BUILDING - ERROR - INITIALIZING - READY type: string readyStateAt: type: number required: - id - output type: object type: array meta: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object monorepoManager: description: An monorepo manager that was used for the deployment examples: - turbo type: - string - "null" name: description: The name of the project associated with the deployment at the time that the deployment was created examples: - my-project type: string ownerId: description: The unique ID of the user or team the deployment belongs to examples: - ZspSRT4ljIEEmMHgoDwKWDei type: string plan: description: The pricing plan the deployment was made under enum: - hobby - enterprise - pro - oss examples: - pro type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean projectId: description: The ID of the project the deployment is associated with examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string public: description: A boolean representing if the deployment is public or not. By default this is `false` examples: - false type: boolean readyState: description: The state of the deployment depending on the process of deploying, or if it is ready or in an error state enum: - QUEUED - BUILDING - ERROR - INITIALIZING - READY - CANCELED examples: - READY type: string regions: description: The regions the deployment exists in examples: - - sfo1 items: type: string type: array routes: description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs items: oneOf: - description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs properties: caseSensitive: type: boolean check: type: boolean continue: type: boolean dest: type: string has: items: oneOf: - properties: type: enum: - host type: string value: type: string required: - type - value type: object - properties: key: type: string type: enum: - header - cookie - query type: string value: type: string required: - type - key type: object type: array headers: additionalProperties: type: string type: object important: type: boolean locale: properties: cookie: type: string redirect: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object type: object methods: items: type: string type: array middleware: description: A middleware index in the `middleware` key under the build result type: number middlewarePath: description: A middleware key within the `output` key under the build result. Overrides a `middleware` definition. type: string middlewareRawSrc: description: The original middleware matchers. items: type: string type: array missing: items: oneOf: - properties: type: enum: - host type: string value: type: string required: - type - value type: object - properties: key: type: string type: enum: - header - cookie - query type: string value: type: string required: - type - key type: object type: array override: type: boolean src: type: string status: type: number required: - src type: object - description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs properties: dest: type: string handle: enum: - filesystem - hit - miss - rewrite - error - resource type: string src: 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 examples: - - dest: https://docs.example.com src: /docs properties: continue: type: boolean middleware: enum: - 0 type: number src: type: string required: - src - continue - middleware type: object type: - array - "null" source: description: Where was the deployment created from enum: - cli - git - import - import/repo - clone/repo examples: - cli type: string target: description: If defined, either `staging` if a staging alias in the format `..now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned enum: - production - staging examples: - null type: - string - "null" team: description: The team that owns the deployment if any properties: id: description: The ID of the team owner examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: string name: description: The name of the team owner examples: - FSociety type: string slug: description: The slug of the team owner examples: - fsociety type: string required: - id - name - slug type: object type: enum: - LAMBDAS type: string url: description: A string with the unique URL of the deployment examples: - my-instant-deployment-3ij3cxz9qr.now.sh type: string userAliases: description: An array of domains that were provided by the user when creating the Deployment. examples: - - sub1.example.com - sub2.example.com items: type: string type: array version: description: The platform version that was used to create the deployment. enum: - 2 examples: - 2 type: number required: - build - createdIn - env - inspectorUrl - isInConcurrentBuildsQueue - meta - name - ownerId - plan - projectId - routes - alias - aliasAssigned - bootedAt - buildingAt - createdAt - creator - id - public - readyState - regions - type - url - version type: object description: The successfully created deployment "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated Deploying 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 security: - bearerToken: [] summary: Create a new deployment tags: - deployments "/v13/deployments/{idOrUrl}": get: description: Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user is an owner of the deployment. operationId: getDeployment parameters: - description: The unique identifier or hostname of the deployment. in: path name: idOrUrl required: true schema: description: The unique identifier or hostname of the deployment. examples: - dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ type: string - description: Whether to add in gitRepo information. in: query name: withGitRepoInfo required: false schema: description: Whether to add in gitRepo information. examples: - "true" type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - description: The deployment including both public and private information properties: alias: description: A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation examples: - [] items: type: string type: array aliasAssigned: description: A boolean that will be true when the aliases from the alias property were assigned successfully examples: - true type: boolean aliasAssignedAt: oneOf: - type: number - type: boolean type: "null" aliasError: description: An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` examples: - null properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" aliasWarning: properties: action: type: string code: type: string link: type: string message: type: string required: - code - message type: - object - "null" automaticAliases: items: type: string type: array bootedAt: type: number build: properties: env: description: The keys of the environment variables that were assigned during the build phase. examples: - - MY_ENV_VAR items: type: string type: array required: - env type: object buildErrorAt: type: number buildingAt: type: number builds: items: type: object type: array canceledAt: type: number checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: description: The ID of Vercel Connect configuration used for this deployment type: string createdAt: description: A number containing the date when the deployment was created in milliseconds examples: - 1540257589405 type: number createdIn: description: The region where the deployment was first created examples: - sfo1 type: string creator: description: Information about the deployment creator properties: uid: description: The ID of the user that created the deployment examples: - 96SnxkFiMyVKsK3pnoHfx3Hz type: string username: description: The username of the user that created the deployment examples: - john-doe type: string required: - uid type: object env: description: The keys of the environment variables that were assigned during runtime examples: - - MY_SECRET items: type: string type: array errorCode: type: string errorLink: type: string errorMessage: type: - string - "null" errorStep: type: string functions: additionalProperties: description: An object used to configure your Serverless Functions examples: - api/test.js: memory: 3008 properties: excludeFiles: type: string includeFiles: type: string maxDuration: type: number memory: type: number runtime: type: string type: object description: An object used to configure your Serverless Functions examples: - api/test.js: memory: 3008 type: - object - "null" gitRepo: oneOf: - properties: defaultBranch: type: string name: type: string namespace: type: string ownerType: enum: - team - user type: string path: type: string private: type: boolean projectId: type: number type: enum: - gitlab type: string url: type: string required: - namespace - projectId - type - url - path - defaultBranch - name - private - ownerType type: object - properties: defaultBranch: type: string name: type: string org: type: string ownerType: enum: - team - user type: string path: type: string private: type: boolean repo: type: string repoId: type: number repoOwnerId: type: string type: enum: - github type: string required: - org - repo - repoId - type - repoOwnerId - path - defaultBranch - name - private - ownerType type: object - properties: defaultBranch: type: string name: type: string owner: type: string ownerType: enum: - team - user type: string path: type: string private: type: boolean repoUuid: type: string slug: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - owner - repoUuid - slug - type - workspaceUuid - path - defaultBranch - name - private - ownerType type: object type: "null" gitSource: oneOf: - properties: prId: type: - number - "null" ref: type: - string - "null" repoId: oneOf: - type: string - type: number sha: type: string type: enum: - github type: string required: - type - repoId type: object - properties: org: type: string prId: type: - number - "null" ref: type: - string - "null" repo: type: string sha: type: string type: enum: - github type: string required: - type - org - repo type: object - properties: prId: type: - number - "null" projectId: oneOf: - type: string - type: number ref: type: - string - "null" sha: type: string type: enum: - gitlab type: string required: - type - projectId type: object - properties: prId: type: - number - "null" ref: type: - string - "null" repoUuid: type: string sha: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - repoUuid type: object - properties: owner: type: string prId: type: - number - "null" ref: type: - string - "null" sha: type: string slug: type: string type: enum: - bitbucket type: string required: - type - owner - slug type: object - properties: gitUrl: type: string ref: type: string sha: type: string type: enum: - custom type: string required: - type - ref - sha - gitUrl type: object - properties: org: type: string ref: type: string repo: type: string repoId: type: number sha: type: string type: enum: - github type: string required: - type - ref - sha - repoId type: object - properties: projectId: type: number ref: type: string sha: type: string type: enum: - gitlab type: string required: - type - ref - sha - projectId type: object - properties: owner: type: string ref: type: string repoUuid: type: string sha: type: string slug: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - ref - sha - workspaceUuid - repoUuid type: object id: description: A string holding the unique ID of the deployment examples: - dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ type: string inspectorUrl: description: Vercel URL to inspect the deployment. examples: - https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq type: - string - "null" isInConcurrentBuildsQueue: description: Is the deployment currently queued waiting for a Concurrent Build Slot to be available examples: - false type: boolean lambdas: items: properties: createdAt: type: number entrypoint: type: - string - "null" id: type: string output: items: properties: functionName: type: string path: type: string required: - path - functionName type: object type: array readyState: enum: - BUILDING - ERROR - INITIALIZING - READY type: string readyStateAt: type: number required: - id - output type: object type: array meta: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object monorepoManager: description: An monorepo manager that was used for the deployment examples: - turbo type: - string - "null" name: description: The name of the project associated with the deployment at the time that the deployment was created examples: - my-project type: string ownerId: description: The unique ID of the user or team the deployment belongs to examples: - ZspSRT4ljIEEmMHgoDwKWDei type: string plan: description: The pricing plan the deployment was made under enum: - hobby - enterprise - pro - oss examples: - pro type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean projectId: description: The ID of the project the deployment is associated with examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string public: description: A boolean representing if the deployment is public or not. By default this is `false` examples: - false type: boolean readyState: description: The state of the deployment depending on the process of deploying, or if it is ready or in an error state enum: - QUEUED - BUILDING - ERROR - INITIALIZING - READY - CANCELED examples: - READY type: string regions: description: The regions the deployment exists in examples: - - sfo1 items: type: string type: array routes: description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs items: oneOf: - description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs properties: caseSensitive: type: boolean check: type: boolean continue: type: boolean dest: type: string has: items: oneOf: - properties: type: enum: - host type: string value: type: string required: - type - value type: object - properties: key: type: string type: enum: - header - cookie - query type: string value: type: string required: - type - key type: object type: array headers: additionalProperties: type: string type: object important: type: boolean locale: properties: cookie: type: string redirect: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object type: object methods: items: type: string type: array middleware: description: A middleware index in the `middleware` key under the build result type: number middlewarePath: description: A middleware key within the `output` key under the build result. Overrides a `middleware` definition. type: string middlewareRawSrc: description: The original middleware matchers. items: type: string type: array missing: items: oneOf: - properties: type: enum: - host type: string value: type: string required: - type - value type: object - properties: key: type: string type: enum: - header - cookie - query type: string value: type: string required: - type - key type: object type: array override: type: boolean src: type: string status: type: number required: - src type: object - description: A list of routes objects used to rewrite paths to point towards other internal or external paths examples: - - dest: https://docs.example.com src: /docs properties: dest: type: string handle: enum: - filesystem - hit - miss - rewrite - error - resource type: string src: 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 examples: - - dest: https://docs.example.com src: /docs properties: continue: type: boolean middleware: enum: - 0 type: number src: type: string required: - src - continue - middleware type: object type: - array - "null" source: description: Where was the deployment created from enum: - cli - git - import - import/repo - clone/repo examples: - cli type: string target: description: If defined, either `staging` if a staging alias in the format `..now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned enum: - production - staging examples: - null type: - string - "null" team: description: The team that owns the deployment if any properties: id: description: The ID of the team owner examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: string name: description: The name of the team owner examples: - FSociety type: string slug: description: The slug of the team owner examples: - fsociety type: string required: - id - name - slug type: object type: enum: - LAMBDAS type: string url: description: A string with the unique URL of the deployment examples: - my-instant-deployment-3ij3cxz9qr.now.sh type: string userAliases: description: An array of domains that were provided by the user when creating the Deployment. examples: - - sub1.example.com - sub2.example.com items: type: string type: array version: description: The platform version that was used to create the deployment. enum: - 2 examples: - 2 type: number required: - build - createdIn - env - inspectorUrl - isInConcurrentBuildsQueue - meta - name - ownerId - plan - projectId - routes - alias - aliasAssigned - bootedAt - buildingAt - createdAt - creator - id - public - readyState - regions - type - url - version type: object - description: The deployment including only public information properties: alias: description: A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation examples: - [] items: type: string type: array aliasAssigned: description: A boolean that will be true when the aliases from the alias property were assigned successfully examples: - true type: boolean aliasError: description: An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null` examples: - null properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" aliasWarning: properties: action: type: string code: type: string link: type: string message: type: string required: - code - message type: - object - "null" automaticAliases: items: type: string type: array bootedAt: type: number buildErrorAt: type: number buildingAt: type: number canceledAt: type: number checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string createdAt: description: A number containing the date when the deployment was created in milliseconds examples: - 1540257589405 type: number creator: description: Information about the deployment creator properties: uid: description: The ID of the user that created the deployment examples: - 96SnxkFiMyVKsK3pnoHfx3Hz type: string username: description: The username of the user that created the deployment examples: - john-doe type: string required: - uid type: object errorCode: type: string errorLink: type: string errorMessage: type: - string - "null" errorStep: type: string gitSource: oneOf: - properties: prId: type: - number - "null" ref: type: - string - "null" repoId: oneOf: - type: string - type: number sha: type: string type: enum: - github type: string required: - type - repoId type: object - properties: org: type: string prId: type: - number - "null" ref: type: - string - "null" repo: type: string sha: type: string type: enum: - github type: string required: - type - org - repo type: object - properties: prId: type: - number - "null" projectId: oneOf: - type: string - type: number ref: type: - string - "null" sha: type: string type: enum: - gitlab type: string required: - type - projectId type: object - properties: prId: type: - number - "null" ref: type: - string - "null" repoUuid: type: string sha: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - repoUuid type: object - properties: owner: type: string prId: type: - number - "null" ref: type: - string - "null" sha: type: string slug: type: string type: enum: - bitbucket type: string required: - type - owner - slug type: object - properties: gitUrl: type: string ref: type: string sha: type: string type: enum: - custom type: string required: - type - ref - sha - gitUrl type: object - properties: org: type: string ref: type: string repo: type: string repoId: type: number sha: type: string type: enum: - github type: string required: - type - ref - sha - repoId type: object - properties: projectId: type: number ref: type: string sha: type: string type: enum: - gitlab type: string required: - type - ref - sha - projectId type: object - properties: owner: type: string ref: type: string repoUuid: type: string sha: type: string slug: type: string type: enum: - bitbucket type: string workspaceUuid: type: string required: - type - ref - sha - workspaceUuid - repoUuid type: object id: description: A string holding the unique ID of the deployment examples: - dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ type: string lambdas: items: properties: createdAt: type: number entrypoint: type: - string - "null" id: type: string output: items: properties: functionName: type: string path: type: string required: - path - functionName type: object type: array readyState: enum: - BUILDING - ERROR - INITIALIZING - READY type: string readyStateAt: type: number required: - id - output type: object type: array meta: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object name: description: The name of the project associated with the deployment at the time that the deployment was created examples: - my-project type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean public: description: A boolean representing if the deployment is public or not. By default this is `false` examples: - false type: boolean readyState: description: The state of the deployment depending on the process of deploying, or if it is ready or in an error state enum: - QUEUED - BUILDING - ERROR - INITIALIZING - READY - CANCELED examples: - READY type: string regions: description: The regions the deployment exists in examples: - - sfo1 items: type: string type: array source: description: Where was the deployment created from enum: - cli - git - import - import/repo - clone/repo examples: - cli type: string target: description: If defined, either `staging` if a staging alias in the format `..now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned enum: - production - staging examples: - null type: - string - "null" team: description: The team that owns the deployment if any properties: id: description: The ID of the team owner examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: string name: description: The name of the team owner examples: - FSociety type: string slug: description: The slug of the team owner examples: - fsociety type: string required: - id - name - slug type: object type: enum: - LAMBDAS type: string url: description: A string with the unique URL of the deployment examples: - my-instant-deployment-3ij3cxz9qr.now.sh type: string userAliases: description: An array of domains that were provided by the user when creating the Deployment. examples: - - sub1.example.com - sub2.example.com items: type: string type: array version: description: The platform version that was used to create the deployment. enum: - 2 examples: - 2 type: number required: - alias - aliasAssigned - bootedAt - buildingAt - createdAt - creator - id - name - meta - public - readyState - regions - type - url - version type: object description: |- The deployment including only public information The deployment including both public and private information "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The deployment was not found security: - bearerToken: [] summary: Get a deployment by ID or URL tags: - deployments "/v13/deployments/{id}": delete: description: This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments. operationId: deleteDeployment parameters: - description: The ID of the deployment to be deleted in: path name: id required: true schema: description: The ID of the deployment to be deleted examples: - dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd type: string - description: A Deployment or Alias URL. In case it is passed, the ID will be ignored in: query name: url required: false schema: description: A Deployment or Alias URL. In case it is passed, the ID will be ignored examples: - https://files-orcin-xi.vercel.app/ type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: state: description: A constant with the final state of the deployment. enum: - DELETED type: string uid: description: The removed deployment ID. examples: - dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd type: string required: - uid - state type: object description: The deployment was successfully deleted "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The deployment was not found security: - bearerToken: [] summary: Delete a Deployment tags: - deployments "/v2/aliases/{aliasId}": delete: description: Delete an Alias with the specified ID. operationId: deleteAlias parameters: - description: The ID or alias that will be removed in: path name: aliasId required: true schema: description: The ID or alias that will be removed examples: - 2WjyKQmM8ZnGcJsPWMrHRHrE oneOf: - type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: status: enum: - SUCCESS type: string required: - status type: object description: The alias was successfully removed "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The alias was not found security: - bearerToken: [] summary: Delete an Alias tags: - aliases "/v2/deployments/{idOrUrl}/events": get: description: Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters. operationId: getDeploymentEvents parameters: - description: The unique identifier or hostname of the deployment. in: path name: idOrUrl required: true schema: description: The unique identifier or hostname of the deployment. examples: - dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd type: string - description: Order of the returned events based on the timestamp. in: query name: direction required: false schema: default: forward description: Order of the returned events based on the timestamp. enum: - backward - forward examples: - backward type: string - description: When enabled, this endpoint will return live events as they happen. in: query name: follow required: false schema: description: When enabled, this endpoint will return live events as they happen. enum: - 0 - 1 examples: - 1 type: number - description: Maximum number of events to return. Provide `-1` to return all available logs. in: query name: limit required: false schema: description: Maximum number of events to return. Provide `-1` to return all available logs. examples: - 100 type: number - description: Deployment build ID. in: query name: name required: false schema: description: Deployment build ID. examples: - bld_cotnkcr76 type: string - description: Timestamp for when build logs should be pulled from. in: query name: since required: false schema: description: Timestamp for when build logs should be pulled from. examples: - 1540095775941 type: number - description: Timestamp for when the build logs should be pulled up until. in: query name: until required: false schema: description: Timestamp for when the build logs should be pulled up until. examples: - 1540106318643 type: number - description: HTTP status code range to filter events by. in: query name: statusCode required: false schema: description: HTTP status code range to filter events by. examples: - 5xx oneOf: - type: number - type: string - in: query name: delimiter required: false schema: enum: - 0 - 1 examples: - 1 type: number - in: query name: builds required: false schema: enum: - 0 - 1 examples: - 1 type: number - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: items: oneOf: - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string serial: type: string text: type: string required: - deploymentId - id - date - serial type: object type: enum: - command type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object serial: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - deployment-state type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object serial: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - delimiter type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: created: type: number date: type: number deploymentId: type: string id: type: string serial: type: string text: type: string required: - date - id - deploymentId - created - serial type: object type: enum: - exit type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object requestId: type: string serial: type: string text: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - middleware type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object requestId: type: string serial: type: string statusCode: type: number text: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - command - stdout - stderr - exit - deployment-state - delimiter - middleware - middleware-invocation - edge-function-invocation - fatal type: string required: - type - created - payload type: object type: array application/stream+json: schema: oneOf: - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string serial: type: string text: type: string required: - deploymentId - id - date - serial type: object type: enum: - command type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object serial: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - deployment-state type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object serial: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - delimiter type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: created: type: number date: type: number deploymentId: type: string id: type: string serial: type: string text: type: string required: - date - id - deploymentId - created - serial type: object type: enum: - exit type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object requestId: type: string serial: type: string text: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - middleware type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object requestId: type: string serial: type: string statusCode: type: number text: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - command - stdout - stderr - exit - deployment-state - delimiter - middleware - middleware-invocation - edge-function-invocation - fatal type: string required: - type - created - payload type: object - oneOf: - type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string serial: type: string text: type: string required: - deploymentId - id - date - serial type: object type: enum: - command type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object serial: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - deployment-state type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object serial: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - delimiter type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: created: type: number date: type: number deploymentId: type: string id: type: string serial: type: string text: type: string required: - date - id - deploymentId - created - serial type: object type: enum: - exit type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object requestId: type: string serial: type: string text: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - middleware type: string required: - type - created - payload type: object - properties: created: type: number payload: properties: date: type: number deploymentId: type: string id: type: string info: properties: entrypoint: type: string name: type: string path: type: string step: type: string type: type: string required: - type - name type: object requestId: type: string serial: type: string statusCode: type: number text: type: string required: - deploymentId - info - id - date - serial type: object type: enum: - command - stdout - stderr - exit - deployment-state - delimiter - middleware - middleware-invocation - edge-function-invocation - fatal type: string required: - type - created - payload type: object description: |- A stream of jsonlines where each line is a deployment log item. Array of deployment logs for the provided query. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The deployment was not found security: - bearerToken: [] summary: Get deployment events tags: - deployments "/v2/deployments/{id}/aliases": get: description: Retrieves all Aliases for the Deployment with the given ID. The authenticated User must own the deployment. operationId: listDeploymentAliases parameters: - description: The ID of the deployment the aliases should be listed for in: path name: id required: true schema: description: The ID of the deployment the aliases should be listed for examples: - dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: aliases: description: A list of the aliases assigned to the deployment items: description: A list of the aliases assigned to the deployment properties: alias: description: The alias name, it could be a `.vercel.app` subdomain or a custom domain examples: - my-alias.vercel.app type: string created: description: The date when the alias was created examples: - 2017-04-26T23:00:34.232Z format: date-time type: string protectionBypass: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object redirect: description: Target destination domain for redirect when the alias is a redirect type: - string - "null" uid: description: The unique identifier of the alias examples: - 2WjyKQmM8ZnGcJsPWMrHRHrE type: string required: - uid - alias - created type: object type: array required: - aliases type: object description: The list of aliases assigned to the deployment "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The deployment was not found security: - bearerToken: [] summary: List Deployment Aliases tags: - aliases post: description: Creates a new alias for the deployment with the given deployment ID. The authenticated user must own this deployment. If the desired alias is already assigned to another deployment, then it will be removed from the old deployment and assigned to the new one. operationId: assignAlias parameters: - description: The ID of the deployment the aliases should be listed for in: path name: id required: true schema: description: The ID of the deployment the aliases should be listed for examples: - dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa oneOf: - type: string - 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: properties: alias: description: The alias we want to assign to the deployment defined in the URL examples: - my-alias.vercel.app type: string redirect: description: The redirect property will take precedence over the deployment id from the URL and consists of a hostname (like test.com) to which the alias should redirect using status code 307 examples: - null type: - string - "null" type: object responses: "200": content: application/json: schema: properties: alias: description: The assigned alias name examples: - my-alias.vercel.app type: string created: description: The date when the alias was created examples: - 2017-04-26T23:00:34.232Z format: date-time type: string oldDeploymentId: description: The unique identifier of the previously aliased deployment, only received when the alias was used before examples: - dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa type: - string - "null" uid: description: The unique identifier of the alias examples: - 2WjyKQmM8ZnGcJsPWMrHRHrE type: string required: - uid - alias - created type: object description: The alias was successfully assigned to the deployment "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The cert for the provided alias is not ready The deployment is not READY and can not be aliased The supplied alias is invalid "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- You do not have permission to access this resource. If no .vercel.app alias exists then we fail (nothing to mirror) "404": description: |- The domain used for the alias was not found The project for the given project can not be found The deployment was not found "409": description: The provided alias is already assigned to the given deployment security: - bearerToken: [] summary: Assign an Alias tags: - aliases "/v2/domains/{domain}/records": post: description: Creates a DNS record for a domain. operationId: createRecord parameters: - description: The domain used to create the DNS record. in: path name: domain required: true schema: description: The domain used to create the DNS record. examples: - example.com type: string - 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: anyOf: - additionalProperties: false properties: name: description: A subdomain name or an empty string for the root domain. examples: - subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `A`. enum: - A type: string value: description: The record value must be a valid IPv4 address. examples: - 192.0.2.42 format: ipv4 type: string required: - type - value - name type: object - additionalProperties: false properties: name: description: A subdomain name or an empty string for the root domain. examples: - subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `AAAA`. enum: - AAAA type: string value: description: An AAAA record pointing to an IPv6 address. examples: - 2001:DB8::42 format: ipv6 type: string required: - type - value - name type: object - additionalProperties: false properties: name: description: A subdomain name or an empty string for the root domain. examples: - subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `ALIAS`. enum: - ALIAS type: string value: description: An ALIAS virtual record pointing to a hostname resolved to an A record on server side. examples: - cname.vercel-dns.com type: string required: - type - value - name type: object - additionalProperties: false properties: name: description: A subdomain name or an empty string for the root domain. examples: - subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `CAA`. enum: - CAA type: string value: description: A CAA record to specify which Certificate Authorities (CAs) are allowed to issue certificates for the domain. examples: - 0 issue \"letsencrypt.org\" type: string required: - type - value - name type: object - additionalProperties: false properties: name: description: A subdomain name or an empty string for the root domain. examples: - subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `CNAME`. enum: - CNAME type: string value: description: A CNAME record mapping to another domain name. examples: - cname.vercel-dns.com type: string required: - type - name type: object - additionalProperties: false properties: mxPriority: examples: - 10 maximum: 65535 minimum: 0 type: number name: description: A subdomain name or an empty string for the root domain. examples: - subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `MX`. enum: - MX type: string value: description: An MX record specifying the mail server responsible for accepting messages on behalf of the domain name. examples: - 10 mail.example.com. type: string required: - type - value - name - mxPriority type: object - additionalProperties: false properties: name: description: A subdomain name or an empty string for the root domain. name: subdomain type: string srv: additionalProperties: false properties: port: anyOf: - examples: - 5000 maximum: 65535 minimum: 0 type: number - type: "null" priority: anyOf: - examples: - 10 maximum: 65535 minimum: 0 type: number - type: "null" target: examples: - host.example.com type: string weight: anyOf: - examples: - 10 maximum: 65535 minimum: 0 type: number - type: "null" required: - weight - port - priority type: object ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `SRV`. enum: - SRV type: string required: - type - name - srv type: object - additionalProperties: false properties: name: description: A subdomain name or an empty string for the root domain. name: subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `TXT`. enum: - TXT type: string value: description: A TXT record containing arbitrary text. examples: - hello type: string required: - type - value - name type: object - additionalProperties: false properties: name: description: A subdomain name. examples: - subdomain type: string ttl: description: The TTL value. Must be a number between 60 and 2147483647. Default value is 60. examples: - 60 maximum: 2147483647 minimum: 60 type: number type: description: Must be of type `NS`. enum: - NS type: string value: description: An NS domain value. examples: - ns1.example.com type: string required: - type - name type: object properties: type: description: The type of record, it could be one of the valid DNS records. enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string required: - type responses: "200": content: application/json: schema: oneOf: - properties: uid: type: string updated: type: number required: - uid - updated type: object - properties: uid: description: The id of the newly created DNS record examples: - rec_V0fra8eEgQwEpFhYG2vTzC3K type: string required: - uid type: object description: Successful response showing the uid of the newly created DNS record. "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "401": description: "" "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" "409": description: "" security: - bearerToken: [] summary: Create a DNS record tags: - dns "/v2/domains/{domain}/records/{recordId}": delete: description: Removes an existing DNS record from a domain name. operationId: removeRecord parameters: - in: path name: domain required: true schema: examples: - example.com type: string - in: path name: recordId required: true schema: examples: - rec_V0fra8eEgQwEpFhYG2vTzC3K type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: type: object description: Successful response by removing the specified DNS record. "400": description: One of the provided values in the request query is invalid. "401": description: "" "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Delete a DNS record tags: - dns /v2/files: post: description: Before you create a deployment you need to upload the required files for that deployment. To do it, you need to first upload each file to this endpoint. Once that's completed, you can create a new deployment with the uploaded files. The file content must be placed inside the body of the request. In the case of a successful response you'll receive a status code 200 with an empty body. operationId: uploadFile parameters: - description: The file size in bytes in: header name: Content-Length schema: description: The file size in bytes type: number - description: The file SHA1 used to check the integrity in: header name: x-vercel-digest schema: description: The file SHA1 used to check the integrity maxLength: 40 type: string - description: The file SHA1 used to check the integrity in: header name: x-now-digest schema: deprecated: true description: The file SHA1 used to check the integrity maxLength: 40 type: string - description: The file size as an alternative to `Content-Length` in: header name: x-now-size schema: deprecated: true description: The file size as an alternative to `Content-Length` type: number - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - properties: urls: description: Array of URLs where the file was updated examples: - - example-upload.aws.com items: type: string type: array required: - urls type: object - type: object description: |- File already uploaded File successfully uploaded "400": description: |- One of the provided values in the headers is invalid Digest is not valid File size is not valid "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Upload Deployment Files tags: - deployments /v2/integrations/log-drains: get: description: Retrieves a list of all Integration log drains that are defined for the authorized account. When using an OAuth2 token, the list is limited to log drains created by the authenticated integration. operationId: getIntegrationLogDrains parameters: - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: items: properties: branch: description: The branch regexp of log drain examples: - feature/* type: string clientId: description: The oauth2 client application id that created this log drain examples: - oac_xRhY4LAB7yLhUADD69EvV7ct type: string configurationId: description: The client configuration this log drain was created with examples: - icfg_cuwj0AdCdH3BwWT4LPijCC7t type: string createdAt: description: A timestamp that tells you when the log drain was created examples: - 1558531915505 type: number createdFrom: description: Whether the log drain was created by an integration or by a user enum: - self-served - integration examples: - integration type: string deliveryFormat: description: The delivery log format enum: - json - ndjson - syslog examples: - json type: string environment: description: The environment of log drain enum: - production - preview examples: - production type: string headers: additionalProperties: type: string description: Construct a type with a set of properties K of type T examples: - '{"Authorization": "Bearer 123"}' type: object id: description: The unique identifier of the log drain. Always prefixed with `ld_` examples: - ld_nBuA7zCID8g4QZ8g type: string name: description: The name of the log drain examples: - My first log drain type: string ownerId: description: The identifier of the team or user whose events will trigger the log drain examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string projectId: examples: - AbCgVkqoxXeXCDWehVir51LHGrrcWL4mkYm14W6UBPWQeb type: - string - "null" projectIds: description: The identifier of the projects this log drain is associated with examples: - AbCgVkqoxXeXCDWehVir51LHGrrcWL4mkYm14W6UBPWQeb items: type: string type: array sources: description: The sources from which logs are currently being delivered to this log drain. examples: - - build - edge items: description: The sources from which logs are currently being delivered to this log drain. enum: - static - lambda - build - edge - external - deployment examples: - - build - edge type: string type: array url: description: The URL to call when logs are generated examples: - https://example.com/log-drain type: string required: - createdAt - id - name - ownerId - url type: object type: array description: A list of log drains "400": description: "" "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Retrieves a list of Integration log drains tags: - logDrains post: description: Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error. operationId: createLogDrain parameters: - 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: properties: branch: description: The branch regexp of log drain examples: - feature/* type: string deliveryFormat: description: The delivery log format enum: - json - ndjson - syslog examples: - json environment: description: The environment of log drain enum: - preview - production examples: - production headers: additionalProperties: type: string description: Headers to be sent together with the request type: object name: description: The name of the log drain examples: - My first log drain maxLength: 100 pattern: ^[A-z0-9_ -]+$ type: string projectIds: items: pattern: ^[a-zA-z0-9_]+$ type: string maxItems: 50 minItems: 1 type: array secret: description: A secret to sign log drain notification headers so a consumer can verify their authenticity examples: - a1Xsfd325fXcs maxLength: 100 pattern: ^[A-z0-9_ -]+$ type: string sources: items: enum: - static - lambda - build - edge - external type: string minItems: 1 type: array uniqueItems: true url: description: The url where you will receive logs. The protocol must be `https://` or `http://` when type is `json` and `ndjson`, and `syslog+tls:` or `syslog:` when the type is `syslog`. examples: - https://example.com/log-drain format: uri pattern: ^(https?|syslog\\+tls|syslog):// type: string required: - name - url type: object responses: "200": content: application/json: schema: properties: branch: description: The branch regexp of log drain examples: - feature/* type: string clientId: description: The oauth2 client application id that created this log drain examples: - oac_xRhY4LAB7yLhUADD69EvV7ct type: string configurationId: description: The client configuration this log drain was created with examples: - icfg_cuwj0AdCdH3BwWT4LPijCC7t type: string createdAt: description: A timestamp that tells you when the log drain was created examples: - 1558531915505 type: number createdFrom: description: Whether the log drain was created by an integration or by a user enum: - self-served - integration examples: - integration type: string deliveryFormat: description: The delivery log format enum: - json - ndjson - syslog examples: - json type: string environment: description: The environment of log drain enum: - preview - production examples: - production type: string headers: additionalProperties: type: string description: Construct a type with a set of properties K of type T examples: - '{"Authorization": "Bearer 123"}' type: object id: description: The unique identifier of the log drain. Always prefixed with `ld_` examples: - ld_nBuA7zCID8g4QZ8g type: string name: description: The name of the log drain examples: - My first log drain type: string ownerId: description: The identifier of the team or user whose events will trigger the log drain examples: - kr1PsOIzqEL5Xg6M4VZcZosf type: string projectId: examples: - AbCgVkqoxXeXCDWehVir51LHGrrcWL4mkYm14W6UBPWQeb type: - string - "null" projectIds: description: The identifier of the projects this log drain is associated with examples: - AbCgVkqoxXeXCDWehVir51LHGrrcWL4mkYm14W6UBPWQeb items: type: string type: array sources: description: The sources from which logs are currently being delivered to this log drain. examples: - - build - edge items: description: The sources from which logs are currently being delivered to this log drain. enum: - static - lambda - build - edge - external - deployment examples: - - build - edge type: string type: array url: description: The URL to call when logs are generated examples: - https://example.com/log-drain type: string required: - createdAt - id - name - ownerId - url type: object description: The log drain was successfully created "400": description: |- One of the provided values in the request body is invalid. The provided token is not from an OAuth2 Client "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Creates a new Integration Log Drain tags: - logDrains "/v2/secrets/{idOrName}": delete: description: This deletes the user's secret defined in the URL. operationId: deleteSecret parameters: - description: The name or the unique identifier to which the secret belongs to. in: path name: idOrName required: true schema: description: The name or the unique identifier to which the secret belongs to. examples: - sec_RKc5iV0rV3ZSrFrHiruRno7k type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: created: description: The date when the secret was created. examples: - 2021-02-10T13:11:49.180Z type: number name: description: The name of the deleted secret. examples: - my-api-key type: string uid: description: The unique identifier of the deleted secret. examples: - sec_XCG7t7AIHuO2SBA8667zNUiM type: string required: - uid - name - created type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Delete a secret tags: - secrets "/v2/secrets/{name}": patch: description: Enables to edit the name of a user's secret. The name has to be unique to that user's secrets. operationId: renameSecret parameters: - description: The name of the secret. in: path name: name required: true schema: description: The name of the secret. examples: - my-api-key type: string - 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: additionalProperties: false properties: name: description: The name of the new secret. examples: - my-api-key maximum: 100 type: string required: - name type: object responses: "200": content: application/json: schema: properties: created: description: Enables basic storage and retrieval of dates and times. format: date-time type: string name: type: string oldName: type: string uid: type: string required: - uid - name - created - oldName type: object description: "" "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Change secret name tags: - secrets post: description: Allows to create a new secret. operationId: createSecret parameters: - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string - description: Automatically added in: path name: name required: true schema: type: string requestBody: content: application/json: schema: additionalProperties: false properties: decryptable: description: Whether the secret value can be decrypted after it has been created. examples: - true type: boolean name: description: The name of the secret (max 100 characters). examples: - my-api-key maximum: 100 type: string projectId: deprecated: true description: Associate a secret to a project. examples: - prj_2WjyKQmM8ZnGcJsPWMrHRHrE type: string value: description: The value of the new secret. examples: - some secret value type: string required: - name - value type: object responses: "200": content: application/json: schema: properties: created: description: The date when the secret was created. examples: - 2021-02-10T13:11:49.180Z format: date-time type: string createdAt: description: Timestamp for when the secret was created. examples: - 1609492210000 type: number decryptable: description: Indicates whether the secret value can be decrypted after it has been created. examples: - true type: boolean name: description: The name of the secret. examples: - my-api-key type: string projectId: description: The unique identifier of the project which the secret belongs to. examples: - prj_2WjyKQmM8ZnGcJsPWMrHRHrE type: string teamId: description: The unique identifier of the team the secret was created for. examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: - string - "null" uid: description: The unique identifier of the secret. examples: - sec_XCG7t7AIHuO2SBA8667zNUiM type: string userId: description: The unique identifier of the user who created the secret. examples: - 2qDDuGFTWXBLDNnqZfWPDp1A type: string value: properties: data: items: type: number type: array type: enum: - Buffer type: string type: object required: - value - created - name - uid type: object description: Successful response showing the created secret. "400": description: One of the provided values in the request body is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Create a new secret tags: - secrets /v2/teams: get: description: Get a paginated list of all the Teams the authenticated User is a member of. operationId: getTeams parameters: - description: Maximum number of Teams which may be returned. in: query name: limit schema: description: Maximum number of Teams which may be returned. examples: - 20 type: number - description: Timestamp (in milliseconds) to only include Teams created since then. in: query name: since schema: description: Timestamp (in milliseconds) to only include Teams created since then. examples: - 1540095775951 type: number - description: Timestamp (in milliseconds) to only include Teams created until then. in: query name: until schema: description: Timestamp (in milliseconds) to only include Teams created until then. examples: - 1540095775951 type: number responses: "200": content: application/json: schema: description: A paginated list of teams. properties: pagination: $ref: "#/components/schemas/Pagination" teams: items: oneOf: - $ref: "#/components/schemas/Team" - $ref: "#/components/schemas/TeamLimited" type: array required: - teams - pagination type: object description: A paginated list of teams. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: List all teams tags: - teams "/v2/teams/{teamId}": get: description: Get information for the Team specified by the `teamId` parameter. operationId: getTeam parameters: - in: query name: slug schema: type: string - description: The Team identifier or slug to perform the request on behalf of. in: path name: teamId required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/Team" description: The requested team "400": description: One of the provided values in the request query is invalid. "403": description: |- You do not have permission to access this resource. Not authorized to access the team. "404": description: Team was not found. security: - bearerToken: [] summary: Get a Team tags: - teams patch: description: Update the information of a Team specified by the `teamId` parameter. The request body should contain the information that will be updated on the Team. operationId: patchTeam parameters: - description: The Team identifier or slug to perform the request on behalf of. in: path name: teamId required: true schema: type: string requestBody: content: application/json: schema: additionalProperties: false properties: avatar: description: The hash value of an uploaded image. format: regex regex: ^[0-9a-f]{40}$ type: string description: description: A short text that describes the team. examples: - Our mission is to make cloud computing accessible to everyone maxLength: 140 type: string emailDomain: examples: - example.com format: regex regex: \\b((?=[a-z0-9-]{1,63}\\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,63}\\b type: - string - "null" enablePreviewFeedback: description: "Enable preview comments: one of on, off or default." examples: - on type: string migrateExistingEnvVariablesToSensitive: description: Runs a task that migrates all existing environment variables to sensitive environment variables. examples: - false type: boolean name: description: The name of the team. examples: - My Team maxLength: 256 type: string previewDeploymentSuffix: description: Suffix that will be used for all preview deployments. examples: - example.dev format: hostname type: - string - "null" regenerateInviteCode: description: Create a new invite code and replace the current one. examples: - true type: boolean remoteCaching: additionalProperties: false description: Whether or not remote caching is enabled for the team properties: enabled: description: Enable or disable remote caching for the team. examples: - true type: boolean type: object saml: additionalProperties: false properties: enforced: description: Require that members of the team use SAML Single Sign-On. examples: - true type: boolean roles: additionalProperties: enum: - OWNER - MEMBER - VIEWER - DEVELOPER - BILLING type: string type: object type: object sensitiveEnvironmentVariablePolicy: description: "Sensitive environment variable policy: one of on, off or default." examples: - on type: string slug: description: A new slug for the team. examples: - my-team type: string type: object responses: "200": content: application/json: schema: $ref: "#/components/schemas/Team" description: "" "400": description: One of the provided values in the request body is invalid. "402": description: "" "403": description: |- You do not have permission to access this resource. Not authorized to update the team. Must be an OWNER. "404": description: Team was not found. security: - bearerToken: [] summary: Update a Team tags: - teams "/v2/teams/{teamId}/members": get: description: Get a paginated list of team members for the provided team. operationId: getTeamMembers parameters: - description: Limit how many teams should be returned in: query name: limit required: false schema: description: Limit how many teams should be returned examples: - 20 type: number - description: Timestamp in milliseconds to only include members added since then. in: query name: since required: false schema: description: Timestamp in milliseconds to only include members added since then. examples: - 1540095775951 type: number - description: Timestamp in milliseconds to only include members added until then. in: query name: until required: false schema: description: Timestamp in milliseconds to only include members added until then. examples: - 1540095775951 type: number - description: Search team members by their name, username, and email. in: query name: search required: false schema: description: Search team members by their name, username, and email. type: string - description: Only return members with the specified team role. in: query name: role required: false schema: description: Only return members with the specified team role. enum: - OWNER - MEMBER - DEVELOPER - VIEWER examples: - OWNER type: string - description: Exclude members who belong to the specified project. in: query name: excludeProject required: false schema: description: Exclude members who belong to the specified project. type: string - description: Automatically added in: path name: teamId required: true schema: type: string responses: "200": content: application/json: schema: description: Paginated list of members for the team. properties: emailInviteCodes: items: properties: createdAt: type: number email: type: string id: type: string isDSyncUser: type: boolean role: enum: - MEMBER - OWNER - VIEWER - DEVELOPER - BILLING type: string required: - id - isDSyncUser type: object type: array members: items: properties: accessRequestedAt: description: Timestamp in milliseconds for when this team member was accepted by an owner. examples: - 1588820733602 type: number avatar: description: ID of the file for the Avatar of this member. examples: - 123a6c5209bc3778245d011443644c8d27dc2c50 type: string bitbucket: description: Information about the Bitbucket account of this user. properties: accountId: type: string email: type: string login: type: string userId: type: number type: object confirmed: description: Boolean that indicates if this member was confirmed by an owner. examples: - true type: boolean createdAt: description: Timestamp in milliseconds when this member was added. examples: - 1588720733602 type: number email: description: The email of this member. examples: - jane.doe@example.com type: string github: description: Information about the GitHub account for this user. properties: accountId: type: string email: type: string login: type: string userId: type: number type: object gitlab: description: Information about the GitLab account of this user. properties: accountId: type: string email: type: string login: type: string userId: type: number type: object joinedFrom: description: Map with information about the members origin if they joined by requesting access. properties: commitId: type: string dsyncConnectedAt: type: number dsyncUserId: type: string gitUserId: oneOf: - type: string - type: number gitUserLogin: type: string idpUserId: type: string origin: enum: - import - gitlab - bitbucket - github - mail - link - teams - saml - dsync - feedback - organization-teams type: string repoId: type: string repoPath: type: string ssoConnectedAt: type: number ssoUserId: type: string required: - origin type: object name: description: The name of this user. examples: - Jane Doe type: string role: description: Role of this user in the team. enum: - MEMBER - OWNER - VIEWER - DEVELOPER - BILLING examples: - OWNER type: string uid: description: The ID of this user. examples: - zTuNVUXEAvvnNN3IaqinkyMw type: string username: description: The unique username of this user. examples: - jane-doe type: string required: - confirmed - email - role - uid - username - createdAt type: object type: array pagination: properties: count: description: Amount of items in the current page. examples: - 20 type: number hasNext: type: boolean next: description: Timestamp that must be used to request the next page. examples: - 1540095775951 type: - number - "null" prev: description: Timestamp that must be used to request the previous page. examples: - 1540095775951 type: - number - "null" required: - hasNext - count - next - prev type: object required: - members - pagination type: object description: Paginated list of members for the team. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: No team was found. security: - bearerToken: [] summary: List team members tags: - teams /v2/user: get: description: Retrieves information related to the currently authenticated User. operationId: getAuthUser parameters: [] responses: "200": content: application/json: schema: description: Successful response. properties: user: oneOf: - $ref: "#/components/schemas/AuthUser" - $ref: "#/components/schemas/AuthUserLimited" required: - user type: object description: Successful response. "400": description: "" "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Get the User tags: - user /v3/events: get: description: Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the `teamId` parameter is supplied, then the events that are returned will be in relation to the Team that was specified. operationId: listUserEvents parameters: - description: Maximum number of items which may be returned. in: query name: limit schema: description: Maximum number of items which may be returned. examples: - 20 type: number - description: Timestamp to only include items created since then. in: query name: since schema: description: Timestamp to only include items created since then. examples: - 2019-12-08T10:00:38.976Z type: string - description: Timestamp to only include items created until then. in: query name: until schema: description: Timestamp to only include items created until then. examples: - 2019-12-09T23:00:38.976Z type: string - description: Comma-delimited list of event \"types\" to filter the results by. in: query name: types schema: description: Comma-delimited list of event \"types\" to filter the results by. examples: - login,team-member-join,domain-buy type: string - description: When retrieving events for a Team, the `userId` parameter may be specified to filter events generated by a specific member of the Team. in: query name: userId schema: description: When retrieving events for a Team, the `userId` parameter may be specified to filter events generated by a specific member of the Team. examples: - aeIInYVk59zbFF2SxfyxxmuO type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: description: Successful response. properties: events: description: Array of events generated by the User. items: $ref: "#/components/schemas/UserEvent" type: array required: - events type: object description: Successful response. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: List User Events tags: - user /v3/secrets: get: description: Retrieves the active Vercel secrets for the authenticated user. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret. operationId: getSecrets parameters: - description: Filter out secrets based on comma separated secret ids. in: query name: id schema: deprecated: true description: Filter out secrets based on comma separated secret ids. examples: - sec_RKc5iV0rV3ZSrFrHiruRno7k,sec_fGc5iV0rV3ZSrFrHiruRnouQ type: string - description: Filter out secrets that belong to a project. in: query name: projectId schema: deprecated: true description: Filter out secrets that belong to a project. examples: - prj_2WjyKQmM8ZnGcJsPWMrHRHrE type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: pagination: $ref: "#/components/schemas/Pagination" secrets: items: description: Data representing a secret. properties: created: description: The date when the secret was created. examples: - 2021-02-10T13:11:49.180Z format: date-time type: string createdAt: description: Timestamp for when the secret was created. examples: - 1609492210000 type: number decryptable: description: Indicates whether the secret value can be decrypted after it has been created. examples: - true type: boolean name: description: The name of the secret. examples: - my-api-key type: string projectId: description: The unique identifier of the project which the secret belongs to. examples: - prj_2WjyKQmM8ZnGcJsPWMrHRHrE type: string teamId: description: The unique identifier of the team the secret was created for. examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: - string - "null" uid: description: The unique identifier of the secret. examples: - sec_XCG7t7AIHuO2SBA8667zNUiM type: string userId: description: The unique identifier of the user who created the secret. examples: - 2qDDuGFTWXBLDNnqZfWPDp1A type: string value: description: The value of the secret. type: string required: - created - name - uid type: object type: array required: - secrets - pagination type: object description: Successful response retrieving a list of secrets. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: List secrets tags: - secrets "/v3/secrets/{idOrName}": get: description: Retrieves the information for a specific secret by passing either the secret id or name in the URL. operationId: getSecret parameters: - description: The name or the unique identifier to which the secret belongs to. in: path name: idOrName required: true schema: description: The name or the unique identifier to which the secret belongs to. examples: - sec_RKc5iV0rV3ZSrFrHiruRno7k type: string - description: Whether to try to decrypt the value of the secret. Only works if `decryptable` has been set to `true` when the secret was created. in: query name: decrypt required: false schema: description: Whether to try to decrypt the value of the secret. Only works if `decryptable` has been set to `true` when the secret was created. enum: - "true" - "false" examples: - "true" type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: description: Data representing a secret. properties: created: description: The date when the secret was created. examples: - 2021-02-10T13:11:49.180Z format: date-time type: string createdAt: description: Timestamp for when the secret was created. examples: - 1609492210000 type: number decryptable: description: Indicates whether the secret value can be decrypted after it has been created. examples: - true type: boolean name: description: The name of the secret. examples: - my-api-key type: string projectId: description: The unique identifier of the project which the secret belongs to. examples: - prj_2WjyKQmM8ZnGcJsPWMrHRHrE type: string teamId: description: The unique identifier of the team the secret was created for. examples: - team_LLHUOMOoDlqOp8wPE4kFo9pE type: - string - "null" uid: description: The unique identifier of the secret. examples: - sec_XCG7t7AIHuO2SBA8667zNUiM type: string userId: description: The unique identifier of the user who created the secret. examples: - 2qDDuGFTWXBLDNnqZfWPDp1A type: string value: description: The value of the secret. type: string required: - created - name - uid type: object description: Successful response retrieving a secret. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get a single secret tags: - secrets /v3/user/tokens: post: description: Creates and returns a new authentication token for the currently authenticated User. The `bearerToken` property is only provided once, in the response body, so be sure to save it on the client for use with API requests. operationId: createAuthToken parameters: - 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: oneOf: - additionalProperties: false properties: expiresAt: type: number name: type: string required: - name type: object - additionalProperties: false properties: clientId: type: string expiresAt: type: number installationId: type: string name: type: string type: enum: - oauth2-token required: - type - name type: object responses: "200": content: application/json: schema: description: Successful response. properties: bearerToken: description: The authentication token's actual value. This token is only provided in this response, and can never be retrieved again in the future. Be sure to save it somewhere safe! examples: - uRKJSTt0L4RaSkiMj41QTkxM type: string token: $ref: "#/components/schemas/AuthToken" required: - token - bearerToken type: object description: Successful response. "400": description: One of the provided values in the request body is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Create an Auth Token tags: - authentication "/v3/user/tokens/{tokenId}": delete: description: Invalidate an authentication token, such that it will no longer be valid for future HTTP requests. operationId: deleteAuthToken parameters: - description: The identifier of the token to invalidate. The special value \"current\" may be supplied, which invalidates the token that the HTTP request was authenticated with. in: path name: tokenId required: true schema: description: The identifier of the token to invalidate. The special value \"current\" may be supplied, which invalidates the token that the HTTP request was authenticated with. examples: - 5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391 type: string responses: "200": content: application/json: schema: description: Authentication token successfully deleted. properties: tokenId: description: The unique identifier of the token that was deleted. examples: - 5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391 type: string required: - tokenId type: object description: Authentication token successfully deleted. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: Token not found with the requested `tokenId`. security: - bearerToken: [] summary: Delete an authentication token tags: - authentication /v4/aliases: get: description: Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases. operationId: listAliases parameters: - description: Get only aliases of the given domain name in: query name: domain schema: description: Get only aliases of the given domain name examples: - my-test-domain.com items: type: string maxItems: 20 oneOf: - type: array - type: string - description: Get only aliases created after the provided timestamp in: query name: from schema: deprecated: true description: Get only aliases created after the provided timestamp examples: - 1540095775951 type: number - description: Maximum number of aliases to list from a request in: query name: limit schema: description: Maximum number of aliases to list from a request examples: - 10 type: number - description: Filter aliases from the given `projectId` in: query name: projectId schema: description: Filter aliases from the given `projectId` examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - description: Get aliases created after this JavaScript timestamp in: query name: since schema: description: Get aliases created after this JavaScript timestamp examples: - 1540095775941 type: number - description: Get aliases created before this JavaScript timestamp in: query name: until schema: description: Get aliases created before this JavaScript timestamp examples: - 1540095775951 type: number - description: Get aliases that would be rolled back for the given deployment in: query name: rollbackDeploymentId schema: description: Get aliases that would be rolled back for the given deployment examples: - dpl_XXX type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: aliases: items: properties: alias: description: The alias name, it could be a `.vercel.app` subdomain or a custom domain examples: - my-alias.vercel.app type: string created: description: The date when the alias was created examples: - 2017-04-26T23:00:34.232Z format: date-time type: string createdAt: description: The date when the alias was created in milliseconds since the UNIX epoch examples: - 1540095775941 type: number creator: description: Information of the user who created the alias properties: email: description: Email of the user who created the alias examples: - john-doe@gmail.com type: string uid: description: ID of the user who created the alias examples: - 96SnxkFiMyVKsK3pnoHfx3Hz type: string username: description: Username of the user who created the alias examples: - john-doe type: string required: - uid - email - username type: object deletedAt: description: The date when the alias was deleted in milliseconds since the UNIX epoch examples: - 1540095775941 type: number deployment: description: A map with the deployment ID, URL and metadata properties: id: description: The deployment unique identifier examples: - dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx type: string meta: description: The deployment metadata examples: - {} type: string url: description: The deployment unique URL examples: - my-instant-deployment-3ij3cxz9qr.now.sh type: string required: - id - url type: object deploymentId: description: The deployment ID examples: - dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx type: - string - "null" projectId: description: The unique identifier of the project examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: - string - "null" protectionBypass: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object redirect: description: Target destination domain for redirect when the alias is a redirect type: - string - "null" redirectStatusCode: description: Status code to be used on redirect enum: - 301 - 302 - 307 - 308 type: - number - "null" uid: description: The unique identifier of the alias type: string updatedAt: description: The date when the alias was updated in milliseconds since the UNIX epoch examples: - 1540095775941 type: number required: - alias - created - deploymentId - projectId - uid type: object type: array pagination: $ref: "#/components/schemas/Pagination" required: - aliases - pagination type: object description: The paginated list of aliases "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: List aliases tags: - aliases "/v4/aliases/{idOrAlias}": get: description: Retrieves an Alias for the given host name or alias ID. operationId: getAlias parameters: - description: Get the alias only if it was created after the provided timestamp in: query name: from required: false schema: deprecated: true description: Get the alias only if it was created after the provided timestamp examples: - 1540095775951 type: number - description: The alias or alias ID to be retrieved in: path name: idOrAlias required: true schema: description: The alias or alias ID to be retrieved examples: - example.vercel.app type: string - description: Get the alias only if it is assigned to the provided project ID in: query name: projectId required: false schema: description: Get the alias only if it is assigned to the provided project ID examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - description: Get the alias only if it was created after this JavaScript timestamp in: query name: since required: false schema: description: Get the alias only if it was created after this JavaScript timestamp examples: - 1540095775941 type: number - description: Get the alias only if it was created before this JavaScript timestamp in: query name: until required: false schema: description: Get the alias only if it was created before this JavaScript timestamp examples: - 1540095775951 type: number - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: alias: description: The alias name, it could be a `.vercel.app` subdomain or a custom domain examples: - my-alias.vercel.app type: string created: description: The date when the alias was created examples: - 2017-04-26T23:00:34.232Z format: date-time type: string createdAt: description: The date when the alias was created in milliseconds since the UNIX epoch examples: - 1540095775941 type: number creator: description: Information of the user who created the alias properties: email: description: Email of the user who created the alias examples: - john-doe@gmail.com type: string uid: description: ID of the user who created the alias examples: - 96SnxkFiMyVKsK3pnoHfx3Hz type: string username: description: Username of the user who created the alias examples: - john-doe type: string required: - uid - email - username type: object deletedAt: description: The date when the alias was deleted in milliseconds since the UNIX epoch examples: - 1540095775941 type: number deployment: description: A map with the deployment ID, URL and metadata properties: id: description: The deployment unique identifier examples: - dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx type: string meta: description: The deployment metadata examples: - {} type: string url: description: The deployment unique URL examples: - my-instant-deployment-3ij3cxz9qr.now.sh type: string required: - id - url type: object deploymentId: description: The deployment ID examples: - dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx type: - string - "null" projectId: description: The unique identifier of the project examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: - string - "null" protectionBypass: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object redirect: description: Target destination domain for redirect when the alias is a redirect type: - string - "null" redirectStatusCode: description: Status code to be used on redirect enum: - 301 - 302 - 307 - 308 type: - number - "null" uid: description: The unique identifier of the alias type: string updatedAt: description: The date when the alias was updated in milliseconds since the UNIX epoch examples: - 1540095775941 type: number required: - alias - created - deploymentId - projectId - uid type: object description: The alias information "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The alias was not found security: - bearerToken: [] summary: Get an Alias tags: - aliases /v4/domains/buy: post: description: Allows to purchase the specified domain. operationId: buyDomain parameters: - 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: additionalProperties: false properties: expectedPrice: description: The price you expect to be charged for the purchase. examples: - 10 type: number name: description: The domain name to purchase. examples: - example.com type: string renew: description: Indicates whether the domain should be automatically renewed. examples: - true type: boolean required: - name type: object responses: "201": content: application/json: schema: properties: domain: properties: created: type: number ns: items: type: string type: array pending: type: boolean uid: type: string verified: type: boolean required: - uid - ns - verified - created - pending type: object required: - domain type: object description: Successful response for purchasing a Domain. "400": description: One of the provided values in the request body is invalid. "403": description: You do not have permission to access this resource. "409": description: "" "429": description: "" security: - bearerToken: [] summary: Purchase a domain tags: - domains /v4/domains/price: get: description: Check the price to purchase a domain and how long a single purchase period is. operationId: checkDomainPrice parameters: - description: The name of the domain for which the price needs to be checked. in: query name: name required: true schema: description: The name of the domain for which the price needs to be checked. examples: - example.com type: string - description: In which status of the domain the price needs to be checked. in: query name: type required: false schema: description: In which status of the domain the price needs to be checked. enum: - new - renewal examples: - new type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: description: Successful response which returns the price of the domain and the period. properties: period: description: The number of years the domain could be held before paying again. examples: - 1 type: number price: description: The domain price in USD. examples: - 20 type: number required: - price - period type: object description: Successful response which returns the price of the domain and the period. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Check the price for a domain tags: - domains /v4/domains/status: get: description: Check if a domain name is available for purchase. operationId: checkDomainStatus parameters: - description: The name of the domain for which we would like to check the status. in: query name: name required: true schema: description: The name of the domain for which we would like to check the status. examples: - example.com type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: available: type: boolean required: - available type: object description: Successful response checking if a Domain's name is available. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Check a Domain Availability tags: - domains "/v4/domains/{domain}/records": get: description: Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options. operationId: getRecords parameters: - in: path name: domain required: true schema: examples: - example.com type: string - description: Maximum number of records to list from a request. in: query name: limit required: false schema: description: Maximum number of records to list from a request. examples: - 20 type: string - description: Get records created after this JavaScript timestamp. in: query name: since required: false schema: description: Get records created after this JavaScript timestamp. examples: - 1609499532000 type: string - description: Get records created before this JavaScript timestamp. in: query name: until required: false schema: description: Get records created before this JavaScript timestamp. examples: - 1612264332000 type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - type: string - properties: records: items: properties: created: type: - number - "null" createdAt: type: - number - "null" creator: type: string id: type: string mxPriority: type: number name: type: string priority: type: number slug: type: string type: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string updated: type: - number - "null" updatedAt: type: - number - "null" value: type: string required: - id - slug - name - type - value - creator - created - updated - createdAt - updatedAt type: object type: array required: - records type: object - description: Successful response retrieving a list of paginated DNS records. properties: pagination: $ref: "#/components/schemas/Pagination" records: items: properties: created: type: - number - "null" createdAt: type: - number - "null" creator: type: string id: type: string mxPriority: type: number name: type: string priority: type: number slug: type: string type: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string updated: type: - number - "null" updatedAt: type: - number - "null" value: type: string required: - id - slug - name - type - value - creator - created - updated - createdAt - updatedAt type: object type: array required: - records - pagination type: object description: Successful response retrieving a list of paginated DNS records. "400": description: One of the provided values in the request query is invalid. "401": description: "" "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: List existing DNS records tags: - dns /v5/domains: get: description: Retrieves a list of domains registered for the authenticating user. By default it returns the last 20 domains if no limit is provided. operationId: getDomains parameters: - description: Maximum number of domains to list from a request. in: query name: limit schema: description: Maximum number of domains to list from a request. examples: - 20 type: number - description: Get domains created after this JavaScript timestamp. in: query name: since schema: description: Get domains created after this JavaScript timestamp. examples: - 1609499532000 type: number - description: Get domains created before this JavaScript timestamp. in: query name: until schema: description: Get domains created before this JavaScript timestamp. examples: - 1612264332000 type: number - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: domains: items: properties: boughtAt: description: If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. examples: - 1613602938882 type: - number - "null" createdAt: description: Timestamp in milliseconds when the domain was created in the registry. examples: - 1613602938882 type: number creator: description: An object containing information of the domain creator, including the user's id, username, and email. examples: - email: demo@example.com id: ZspSRT4ljIEEmMHgoDwKWDei username: vercel_user properties: customerId: type: - string - "null" email: type: string id: type: string isDomainReseller: type: boolean username: type: string required: - username - email - id type: object customNameservers: description: A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. examples: - - ns1.nameserver.net - ns2.nameserver.net items: type: string type: array expiresAt: description: Timestamp in milliseconds at which the domain is set to expire. `null` if not bought with Vercel. examples: - 1613602938882 type: - number - "null" id: description: The unique identifier of the domain. examples: - EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1 type: string intendedNameservers: description: A list of the intended nameservers for the domain to point to Vercel DNS. examples: - - ns1.vercel-dns.com - ns2.vercel-dns.com items: type: string type: array name: description: The domain name. examples: - example.com type: string nameservers: description: A list of the current nameservers of the domain. examples: - - ns1.nameserver.net - ns2.nameserver.net items: type: string type: array orderedAt: description: Timestamp in milliseconds at which the domain was ordered. examples: - 1613602938882 type: number renew: description: Indicates whether the domain is set to automatically renew. examples: - true type: boolean serviceType: description: The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. enum: - zeit.world - external - na examples: - zeit.world type: string transferStartedAt: description: If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. examples: - 1613602938882 type: number transferredAt: description: Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. examples: - 1613602938882 type: - number - "null" verified: description: If the domain has the ownership verified. examples: - true type: boolean required: - verified - nameservers - intendedNameservers - creator - createdAt - id - name - expiresAt - boughtAt - serviceType type: object type: array pagination: $ref: "#/components/schemas/Pagination" required: - domains - pagination type: object description: Successful response retrieving a list of domains. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "409": description: "" security: - bearerToken: [] summary: List all the domains tags: - domains post: description: This endpoint is used for registering a new domain name with Vercel for the authenticating user, and also for initiating a domain transfer request from an external Registrar to Vercel. operationId: createOrTransferDomain parameters: - 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: oneOf: - additionalProperties: false properties: method: description: The domain operation to perform. examples: - move-in type: string name: description: The domain name you want to add. examples: - example.com type: string token: description: The move-in token from Move Requested email. examples: - fdhfr820ad#@FAdlj$$ type: string required: - method - name type: object - additionalProperties: false properties: authCode: description: The authorization code assigned to the domain. examples: - fdhfr820ad#@FAdlj$$ type: string expectedPrice: description: The price you expect to be charged for the required 1 year renewal. examples: - 8 type: number method: description: The domain operation to perform. examples: - transfer-in type: string name: description: The domain name you want to add. examples: - example.com type: string required: - method - name type: object - additionalProperties: false properties: cdnEnabled: description: Whether the domain has the Vercel Edge Network enabled or not. examples: - true type: boolean method: description: The domain operation to perform. examples: - add type: string name: description: The domain name you want to add. examples: - example.com type: string zone: type: boolean required: - name type: object properties: method: description: The domain operation to perform. It can be either `add` or `transfer-in`. examples: - transfer-in type: string responses: "200": content: application/json: schema: properties: domain: properties: boughtAt: description: If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. examples: - 1613602938882 type: - number - "null" createdAt: description: Timestamp in milliseconds when the domain was created in the registry. examples: - 1613602938882 type: number creator: description: An object containing information of the domain creator, including the user's id, username, and email. examples: - email: demo@example.com id: ZspSRT4ljIEEmMHgoDwKWDei username: vercel_user properties: customerId: type: - string - "null" email: type: string id: type: string isDomainReseller: type: boolean username: type: string required: - username - email - id type: object customNameservers: description: A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. examples: - - ns1.nameserver.net - ns2.nameserver.net items: type: string type: array expiresAt: description: Timestamp in milliseconds at which the domain is set to expire. `null` if not bought with Vercel. examples: - 1613602938882 type: - number - "null" id: description: The unique identifier of the domain. examples: - EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1 type: string intendedNameservers: description: A list of the intended nameservers for the domain to point to Vercel DNS. examples: - - ns1.vercel-dns.com - ns2.vercel-dns.com items: type: string type: array name: description: The domain name. examples: - example.com type: string nameservers: description: A list of the current nameservers of the domain. examples: - - ns1.nameserver.net - ns2.nameserver.net items: type: string type: array orderedAt: description: Timestamp in milliseconds at which the domain was ordered. examples: - 1613602938882 type: number renew: description: Indicates whether the domain is set to automatically renew. examples: - true type: boolean serviceType: description: The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. enum: - zeit.world - external - na examples: - zeit.world type: string transferStartedAt: description: If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. examples: - 1613602938882 type: number transferredAt: description: Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. examples: - 1613602938882 type: - number - "null" verified: description: If the domain has the ownership verified. examples: - true type: boolean required: - verified - nameservers - intendedNameservers - creator - createdAt - id - name - expiresAt - boughtAt - serviceType type: object required: - domain type: object description: "" "400": description: One of the provided values in the request body is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" "409": description: "" security: - bearerToken: [] summary: Register or transfer-in a new Domain tags: - domains "/v5/domains/{domain}": get: description: Get information for a single domain in an account or team. operationId: getDomain parameters: - description: The name of the domain. in: path name: domain required: true schema: description: The name of the domain. examples: - example.com type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: domain: properties: boughtAt: description: If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. examples: - 1613602938882 type: - number - "null" createdAt: description: Timestamp in milliseconds when the domain was created in the registry. examples: - 1613602938882 type: number creator: description: An object containing information of the domain creator, including the user's id, username, and email. examples: - email: demo@example.com id: ZspSRT4ljIEEmMHgoDwKWDei username: vercel_user properties: customerId: type: - string - "null" email: type: string id: type: string isDomainReseller: type: boolean username: type: string required: - username - email - id type: object customNameservers: description: A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. examples: - - ns1.nameserver.net - ns2.nameserver.net items: type: string type: array expiresAt: description: Timestamp in milliseconds at which the domain is set to expire. `null` if not bought with Vercel. examples: - 1613602938882 type: - number - "null" id: description: The unique identifier of the domain. examples: - EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1 type: string intendedNameservers: description: A list of the intended nameservers for the domain to point to Vercel DNS. examples: - - ns1.vercel-dns.com - ns2.vercel-dns.com items: type: string type: array name: description: The domain name. examples: - example.com type: string nameservers: description: A list of the current nameservers of the domain. examples: - - ns1.nameserver.net - ns2.nameserver.net items: type: string type: array orderedAt: description: Timestamp in milliseconds at which the domain was ordered. examples: - 1613602938882 type: number renew: description: Indicates whether the domain is set to automatically renew. examples: - true type: boolean serviceType: description: The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. enum: - zeit.world - external - na examples: - zeit.world type: string suffix: type: boolean transferStartedAt: description: If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. examples: - 1613602938882 type: number transferredAt: description: Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. examples: - 1613602938882 type: - number - "null" verified: description: If the domain has the ownership verified. examples: - true type: boolean required: - suffix - verified - nameservers - intendedNameservers - creator - createdAt - id - name - expiresAt - boughtAt - serviceType type: object required: - domain type: object description: Successful response retrieving an information for a specific domains. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get Information for a Single Domain tags: - domains /v5/user/tokens: get: description: Retrieve a list of the current User's authentication tokens. operationId: listAuthTokens parameters: [] responses: "200": content: application/json: schema: properties: pagination: $ref: "#/components/schemas/Pagination" testingToken: $ref: "#/components/schemas/AuthToken" tokens: items: $ref: "#/components/schemas/AuthToken" type: array required: - tokens - pagination type: object description: "" "400": description: "" "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: List Auth Tokens tags: - authentication "/v5/user/tokens/{tokenId}": get: description: Retrieve metadata about an authentication token belonging to the currently authenticated User. operationId: getAuthToken parameters: - description: The identifier of the token to retrieve. The special value \"current\" may be supplied, which returns the metadata for the token that the current HTTP request is authenticated with. in: path name: tokenId required: true schema: description: The identifier of the token to retrieve. The special value \"current\" may be supplied, which returns the metadata for the token that the current HTTP request is authenticated with. examples: - 5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391 type: string responses: "200": content: application/json: schema: description: Successful response. properties: token: $ref: "#/components/schemas/AuthToken" required: - token type: object description: Successful response. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: Token not found with the requested `tokenId`. security: - bearerToken: [] summary: Get Auth Token Metadata tags: - authentication /v6/deployments: get: description: List deployments under the account corresponding to the API token. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`. operationId: getDeployments parameters: - description: Name of the deployment. in: query name: app schema: description: Name of the deployment. examples: - docs type: string - description: "Gets the deployment created after this Date timestamp. (default: current time)" in: query name: from schema: deprecated: true description: "Gets the deployment created after this Date timestamp. (default: current time)" examples: - 1612948664566 type: number - description: Maximum number of deployments to list from a request. in: query name: limit schema: description: Maximum number of deployments to list from a request. examples: - 10 type: number - description: Filter deployments from the given `projectId`. in: query name: projectId schema: description: Filter deployments from the given `projectId`. examples: - QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY type: string - description: Filter deployments based on the environment. in: query name: target schema: description: Filter deployments based on the environment. enum: - production - preview examples: - production type: string - description: "Gets the deployment created before this Date timestamp. (default: current time)" in: query name: to schema: deprecated: true description: "Gets the deployment created before this Date timestamp. (default: current time)" examples: - 1612948664566 type: number - description: Filter out deployments based on users who have created the deployment. in: query name: users schema: description: Filter out deployments based on users who have created the deployment. examples: - kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY type: string - description: Get Deployments created after this JavaScript timestamp. in: query name: since schema: description: Get Deployments created after this JavaScript timestamp. examples: - 1540095775941 type: number - description: Get Deployments created before this JavaScript timestamp. in: query name: until schema: description: Get Deployments created before this JavaScript timestamp. examples: - 1540095775951 type: number - description: Filter deployments based on their state (`BUILDING`, `ERROR`, `INITIALIZING`, `QUEUED`, `READY`, `CANCELED`) in: query name: state schema: description: Filter deployments based on their state (`BUILDING`, `ERROR`, `INITIALIZING`, `QUEUED`, `READY`, `CANCELED`) examples: - BUILDING,READY type: string - description: Filter deployments based on their rollback candidacy in: query name: rollbackCandidate schema: description: Filter deployments based on their rollback candidacy type: boolean - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: deployments: items: properties: aliasAssigned: oneOf: - type: number - type: boolean type: "null" aliasError: description: An error object in case aliasing of the deployment failed. properties: code: type: string message: type: string required: - code - message type: - object - "null" buildingAt: description: Timestamp of when the deployment started building at. examples: - 1609492210000 type: number checksConclusion: description: Conclusion for checks enum: - succeeded - failed - skipped - canceled type: string checksState: description: State of all registered checks enum: - registered - running - completed type: string connectConfigurationId: description: The ID of Vercel Connect configuration used for this deployment type: string created: description: Timestamp of when the deployment got created. examples: - 1609492210000 type: number createdAt: description: Timestamp of when the deployment got created. examples: - 1609492210000 type: number creator: description: Metadata information of the user who created the deployment. properties: email: description: The email address of the user. examples: - example@example.com type: string githubLogin: description: The GitHub login of the user. examples: - johndoe type: string gitlabLogin: description: The GitLab login of the user. examples: - johndoe type: string uid: description: The unique identifier of the user. examples: - eLrCnEgbKhsHyfbiNR7E8496 type: string username: description: The username of the user. examples: - johndoe type: string required: - uid type: object inspectorUrl: description: Vercel URL to inspect the deployment. examples: - https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq type: - string - "null" isRollbackCandidate: description: Deployment can be used for instant rollback type: - boolean - "null" meta: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object name: description: The name of the deployment. examples: - docs type: string projectSettings: description: The project settings which was used for this deployment properties: buildCommand: type: - string - "null" commandForIgnoringBuildStep: type: - string - "null" createdAt: type: number devCommand: type: - string - "null" framework: enum: - 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 type: - string - "null" gitForkProtection: type: boolean gitLFS: type: boolean installCommand: type: - string - "null" nodeVersion: enum: - 18.x - 16.x - 14.x - 12.x - 10.x type: string outputDirectory: type: - string - "null" publicSource: type: - boolean - "null" rootDirectory: type: - string - "null" serverlessFunctionRegion: type: - string - "null" skipGitConnectDuringLink: type: boolean sourceFilesOutsideRootDirectory: type: boolean type: object ready: description: Timestamp of when the deployment got ready. examples: - 1609492210000 type: number source: description: The source of the deployment. enum: - cli - git - import - import/repo - clone/repo examples: - cli type: string state: description: In which state is the deployment. enum: - BUILDING - ERROR - INITIALIZING - QUEUED - READY - CANCELED examples: - READY type: string target: description: On which environment has the deployment been deployed to. enum: - production - staging examples: - production type: - string - "null" type: description: The type of the deployment. enum: - LAMBDAS examples: - LAMBDAS type: string uid: description: The unique identifier of the deployment. examples: - dpl_2euZBFqxYdDMDG1jTrHFnNZ2eUVa type: string url: description: The URL of the deployment. examples: - docs-9jaeg38me.vercel.app type: string required: - uid - name - url - created - type - creator - inspectorUrl type: object type: array pagination: $ref: "#/components/schemas/Pagination" required: - pagination - deployments type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: List deployments tags: - deployments "/v6/deployments/{id}/files": get: description: Allows to retrieve the file structure of a deployment by supplying the deployment unique identifier. operationId: listDeploymentFiles parameters: - description: The unique deployment identifier in: path name: id required: true schema: description: The unique deployment identifier type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/FileTree" type: array description: Retrieved the file tree successfully "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: |- File tree not found Deployment not found security: - bearerToken: [] summary: List Deployment Files tags: - deployments "/v6/deployments/{id}/files/{fileId}": get: description: Allows to retrieve the content of a file by supplying the file identifier and the deployment unique identifier. The response body will contain the raw content of the file. operationId: getDeploymentFileContents parameters: - description: The unique deployment identifier in: path name: id required: true schema: description: The unique deployment identifier type: string - description: The unique file identifier in: path name: fileId required: true schema: description: The unique file identifier type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: |- File not found Deployment not found security: - bearerToken: [] summary: Get Deployment File Contents tags: - deployments "/v6/domains/{domain}": delete: description: Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases. operationId: deleteDomain parameters: - description: The name of the domain. in: path name: domain required: true schema: description: The name of the domain. examples: - example.com type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: uid: type: string required: - uid type: object description: Successful response removing a domain. "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" "409": description: "" security: - bearerToken: [] summary: Remove a domain by name tags: - domains "/v6/domains/{domain}/config": get: description: Get a Domain's configuration. operationId: getDomainConfig parameters: - description: The name of the domain. in: path name: domain required: true schema: description: The name of the domain. examples: - example.com type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: acceptedChallenges: description: Which challenge types the domain can use for issuing certs. items: description: Which challenge types the domain can use for issuing certs. enum: - dns-01 - http-01 type: string type: array configuredBy: description: "How we see the domain's configuration. - `CNAME`: Domain has a CNAME pointing to Vercel. - `A`: Domain's A record is resolving to Vercel. - `http`: Domain is resolving to Vercel but may be behind a Proxy. - `null`: Domain is not resolving to Vercel." enum: - CNAME - A - http type: - string - "null" misconfigured: description: Whether or not the domain is configured AND we can automatically generate a TLS certificate. type: boolean required: - misconfigured type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Get a Domain's configuration tags: - domains /v7/certs: post: description: Issue a new cert operationId: issueCert parameters: - 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: properties: cns: description: The common names the cert should be issued for items: type: string type: array type: object responses: "200": content: application/json: schema: properties: autoRenew: type: boolean cns: items: type: string type: array createdAt: type: number expiresAt: type: number id: type: string required: - id - createdAt - expiresAt - autoRenew - cns type: object description: "" "400": description: One of the provided values in the request body is invalid. "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "404": description: "" "429": description: "" "449": description: "" "500": description: "" security: - bearerToken: [] summary: Issue a new cert tags: - certs put: description: Upload a cert operationId: uploadCert parameters: - 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: additionalProperties: false properties: ca: description: The certificate authority type: string cert: description: The certificate type: string key: description: The certificate key type: string skipValidation: description: Skip validation of the certificate type: boolean required: - ca - key - cert type: object responses: "200": content: application/json: schema: properties: autoRenew: type: boolean cns: items: type: string type: array createdAt: type: number expiresAt: type: number id: type: string required: - id - createdAt - expiresAt - autoRenew - cns type: object description: "" "400": description: One of the provided values in the request body is invalid. "402": description: |- This feature is only available for Enterprise customers. This feature is optionally available for advanced use cases. Contact Sales: https://vercel.com/contact/sales "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Upload a cert tags: - certs "/v7/certs/{id}": delete: description: Remove cert operationId: removeCert parameters: - description: The cert id to remove in: path name: id required: true schema: description: The cert id to remove type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Remove cert tags: - certs get: description: Get cert by id operationId: getCertById parameters: - description: The cert id in: path name: id required: true schema: description: The cert id type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: autoRenew: type: boolean cns: items: type: string type: array createdAt: type: number expiresAt: type: number id: type: string required: - id - createdAt - expiresAt - autoRenew - cns type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" security: - bearerToken: [] summary: Get cert by id tags: - certs /v8/artifacts: post: description: Query information about an array of artifacts. operationId: artifactQuery parameters: - 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: properties: hashes: description: artifact hashes items: type: string type: array required: - hashes type: object responses: "400": description: One of the provided values in the request body is invalid. "401": description: |- Invalid token The request is missing an authentication token "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- The customer has reached their spend cap limit and has been paused. An owner can disable the cap or raise the limit in settings. The Remote Caching usage limit has been reached for this account for this billing cycle. Remote Caching has been disabled for this team or user. An owner can enable it in the billing settings. You do not have permission to access this resource. security: - bearerToken: [] summary: Query information about an artifact tags: - artifacts /v8/artifacts/events: post: description: Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are `HIT` and `MISS`. The source is either `LOCAL` the cache event was on the users filesystem cache or `REMOTE` if the cache event is for a remote cache. When the event is a `HIT` the request also accepts a number `duration` which is the time taken to generate the artifact in the cache. operationId: recordEvents parameters: - description: The continuous integration or delivery environment where this artifact is downloaded. in: header name: x-artifact-client-ci schema: description: The continuous integration or delivery environment where this artifact is downloaded. examples: - VERCEL maxLength: 50 type: string - description: 1 if the client is an interactive shell. Otherwise 0 in: header name: x-artifact-client-interactive schema: description: 1 if the client is an interactive shell. Otherwise 0 examples: - 0 maximum: 1 minimum: 0 type: integer - 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: items: additionalProperties: false properties: duration: description: The time taken to generate the artifact. This should be sent as a body parameter on `HIT` events. examples: - 400 type: number event: description: One of `HIT` or `MISS`. `HIT` specifies that a cached artifact for `hash` was found in the cache. `MISS` specifies that a cached artifact with `hash` was not found. enum: - HIT - MISS type: string hash: description: The artifact hash examples: - 12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string sessionId: description: A UUID (universally unique identifer) for the session that generated this event. type: string source: description: One of `LOCAL` or `REMOTE`. `LOCAL` specifies that the cache event was from the user's filesystem cache. `REMOTE` specifies that the cache event is from a remote cache. enum: - LOCAL - REMOTE type: string required: - sessionId - source - hash - event type: object type: array responses: "200": description: Success. Event recorded. "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the headers is invalid "401": description: |- Invalid token The request is missing an authentication token "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- The customer has reached their spend cap limit and has been paused. An owner can disable the cap or raise the limit in settings. The Remote Caching usage limit has been reached for this account for this billing cycle. Remote Caching has been disabled for this team or user. An owner can enable it in the billing settings. You do not have permission to access this resource. security: - bearerToken: [] summary: Record an artifacts cache usage event tags: - artifacts /v8/artifacts/status: get: description: Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits. operationId: status parameters: - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "400": description: "" "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Get status of Remote Caching for this principal tags: - artifacts "/v8/artifacts/{hash}": get: description: Downloads a cache artifact indentified by its `hash` specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the content-length header and response body. operationId: downloadArtifact parameters: - description: The continuous integration or delivery environment where this artifact is downloaded. in: header name: x-artifact-client-ci schema: description: The continuous integration or delivery environment where this artifact is downloaded. examples: - VERCEL maxLength: 50 type: string - description: 1 if the client is an interactive shell. Otherwise 0 in: header name: x-artifact-client-interactive schema: description: 1 if the client is an interactive shell. Otherwise 0 examples: - 0 maximum: 1 minimum: 0 type: integer - description: The artifact hash in: path name: hash required: true schema: description: The artifact hash examples: - 12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "400": description: |- One of the provided values in the request query is invalid. One of the provided values in the headers is invalid "401": description: |- Invalid token The request is missing an authentication token "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- The customer has reached their spend cap limit and has been paused. An owner can disable the cap or raise the limit in settings. The Remote Caching usage limit has been reached for this account for this billing cycle. Remote Caching has been disabled for this team or user. An owner can enable it in the billing settings. You do not have permission to access this resource. security: - bearerToken: [] summary: Download a cache artifact tags: - artifacts head: description: Check that a cache artifact with the given `hash` exists. This request returns response headers only and is equivalent to a `GET` request to this endpoint where the response contains no body. operationId: artifactExists parameters: - description: The artifact hash in: path name: hash required: true schema: description: The artifact hash examples: - 12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "400": description: One of the provided values in the request query is invalid. "401": description: |- Invalid token The request is missing an authentication token "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- The customer has reached their spend cap limit and has been paused. An owner can disable the cap or raise the limit in settings. The Remote Caching usage limit has been reached for this account for this billing cycle. Remote Caching has been disabled for this team or user. An owner can enable it in the billing settings. You do not have permission to access this resource. security: - bearerToken: [] summary: Check if a cache artifact exists tags: - artifacts put: description: Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`. operationId: uploadArtifact parameters: - description: The artifact size in bytes in: header name: Content-Length required: true schema: description: The artifact size in bytes type: number - description: The time taken to generate the uploaded artifact in milliseconds. in: header name: x-artifact-duration required: false schema: description: The time taken to generate the uploaded artifact in milliseconds. examples: - 400 type: number - description: The continuous integration or delivery environment where this artifact was generated. in: header name: x-artifact-client-ci required: false schema: description: The continuous integration or delivery environment where this artifact was generated. examples: - VERCEL maxLength: 50 type: string - description: 1 if the client is an interactive shell. Otherwise 0 in: header name: x-artifact-client-interactive required: false schema: description: 1 if the client is an interactive shell. Otherwise 0 examples: - 0 maximum: 1 minimum: 0 type: integer - description: The base64 encoded tag for this artifact. The value is sent back to clients when the artifact is downloaded as the header `x-artifact-tag` in: header name: x-artifact-tag required: false schema: description: The base64 encoded tag for this artifact. The value is sent back to clients when the artifact is downloaded as the header `x-artifact-tag` examples: - Tc0BmHvJYMIYJ62/zx87YqO0Flxk+5Ovip25NY825CQ= maxLength: 600 type: string - description: The artifact hash in: path name: hash required: true schema: description: The artifact hash examples: - 12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string requestBody: content: application/octet-stream: schema: {} responses: "400": description: |- One of the provided values in the request query is invalid. One of the provided values in the headers is invalid "401": description: |- Invalid token The request is missing an authentication token "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: |- The customer has reached their spend cap limit and has been paused. An owner can disable the cap or raise the limit in settings. The Remote Caching usage limit has been reached for this account for this billing cycle. Remote Caching has been disabled for this team or user. An owner can enable it in the billing settings. You do not have permission to access this resource. security: - bearerToken: [] summary: Upload a cache artifact tags: - artifacts /v9/projects: get: description: Allows to retrieve the list of projects of the authenticated user. The list will be paginated and the provided query parameters allow filtering the returned projects. operationId: getProjects parameters: - description: Query only projects updated after the given timestamp in: query name: from schema: description: Query only projects updated after the given timestamp type: string - description: Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed in: query name: gitForkProtection schema: description: Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed enum: - "1" - "0" examples: - "1" type: string - description: Limit the number of projects returned in: query name: limit schema: description: Limit the number of projects returned type: string - description: Search projects by the name field in: query name: search schema: description: Search projects by the name field type: string - description: Filter results by repo. Also used for project count in: query name: repo schema: description: Filter results by repo. Also used for project count type: string - description: Filter results by Repository ID. in: query name: repoId schema: description: Filter results by Repository ID. type: string - description: Filter results by Repository URL. in: query name: repoUrl schema: description: Filter results by Repository URL. examples: - https://github.com/vercel/next.js type: string - description: Filter results by excluding those projects that belong to a repo in: query name: excludeRepos schema: description: Filter results by excluding those projects that belong to a repo type: string - description: Filter results by connected Edge Config ID in: query name: edgeConfigId schema: description: Filter results by connected Edge Config ID type: string - description: Filter results by connected Edge Config Token ID in: query name: edgeConfigTokenId schema: description: Filter results by connected Edge Config Token ID type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: pagination: $ref: "#/components/schemas/Pagination" projects: items: properties: accountId: type: string analytics: properties: canceledAt: type: - number - "null" disabledAt: type: number enabledAt: type: number id: type: string paidAt: type: number sampleRatePercent: type: - number - "null" spendLimitInDollars: type: - number - "null" required: - id - canceledAt - disabledAt - enabledAt type: object autoExposeSystemEnvs: type: boolean buildCommand: type: - string - "null" commandForIgnoringBuildStep: type: - string - "null" connectBuildsEnabled: type: boolean connectConfigurationId: type: - string - "null" createdAt: type: number devCommand: type: - string - "null" directoryListing: type: boolean enablePreviewFeedback: type: - boolean - "null" env: items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object type: array framework: enum: - 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 type: - string - "null" gitForkProtection: type: boolean gitLFS: type: boolean hasActiveBranches: type: boolean hasFloatingAliases: type: boolean id: type: string installCommand: type: - string - "null" lastRollbackTarget: properties: fromDeploymentId: type: string jobStatus: enum: - succeeded - failed - skipped - pending - in-progress type: string requestedAt: type: number toDeploymentId: type: string required: - fromDeploymentId - toDeploymentId - jobStatus - requestedAt type: - object - "null" latestDeployments: items: properties: alias: items: type: string type: array aliasAssigned: oneOf: - type: number - type: boolean type: "null" aliasError: properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" automaticAliases: items: type: string type: array buildingAt: type: number builds: items: properties: dest: type: string src: type: string use: type: string required: - use type: object type: array checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: type: string createdAt: type: number createdIn: type: string creator: properties: email: type: string githubLogin: type: string gitlabLogin: type: string uid: type: string username: type: string required: - email - uid - username type: - object - "null" deploymentHostname: type: string forced: type: boolean id: type: string meta: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object monorepoManager: type: - string - "null" name: type: string plan: enum: - hobby - enterprise - pro - oss type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean private: type: boolean readyAt: type: number readyState: enum: - BUILDING - ERROR - INITIALIZING - QUEUED - READY - CANCELED type: string requestedAt: type: number target: type: - string - "null" teamId: type: - string - "null" type: enum: - LAMBDAS type: string url: type: string userId: type: string withCache: type: boolean required: - createdAt - createdIn - creator - deploymentHostname - name - id - plan - private - readyState - type - url - userId type: object type: array link: oneOf: - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string org: type: string productionBranch: type: string repo: type: string repoId: type: number sourceless: type: boolean type: enum: - github type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string productionBranch: type: string projectId: type: string projectName: type: string projectNameWithNamespace: type: string projectNamespace: type: string projectUrl: type: string sourceless: type: boolean type: enum: - gitlab type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string name: type: string owner: type: string productionBranch: type: string slug: type: string sourceless: type: boolean type: enum: - bitbucket type: string updatedAt: type: number uuid: type: string workspaceUuid: type: string required: - deployHooks type: object live: type: boolean name: type: string nodeVersion: enum: - 18.x - 16.x - 14.x - 12.x - 10.x type: string outputDirectory: type: - string - "null" passwordProtection: properties: deploymentType: enum: - preview - all type: string required: - deploymentType type: - object - "null" permissions: properties: Monitoring: items: $ref: "#/components/schemas/ACLAction" type: array aliasGlobal: items: $ref: "#/components/schemas/ACLAction" type: array aliasProject: items: $ref: "#/components/schemas/ACLAction" type: array aliasProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array analytics: items: $ref: "#/components/schemas/ACLAction" type: array analyticsSampling: items: $ref: "#/components/schemas/ACLAction" type: array analyticsUsage: items: $ref: "#/components/schemas/ACLAction" type: array auditLog: items: $ref: "#/components/schemas/ACLAction" type: array billingAddress: items: $ref: "#/components/schemas/ACLAction" type: array billingInformation: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoice: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceEmailRecipient: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceLanguage: items: $ref: "#/components/schemas/ACLAction" type: array billingPlan: items: $ref: "#/components/schemas/ACLAction" type: array billingPurchaseOrder: items: $ref: "#/components/schemas/ACLAction" type: array billingTaxId: items: $ref: "#/components/schemas/ACLAction" type: array blob: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifact: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifactUsageEvent: items: $ref: "#/components/schemas/ACLAction" type: array concurrentBuilds: items: $ref: "#/components/schemas/ACLAction" type: array connect: items: $ref: "#/components/schemas/ACLAction" type: array connectConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array connectConfigurationLink: items: $ref: "#/components/schemas/ACLAction" type: array deployment: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheck: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckReRunFromProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPrivate: items: $ref: "#/components/schemas/ACLAction" type: array deploymentProductionGit: items: $ref: "#/components/schemas/ACLAction" type: array deploymentRollback: items: $ref: "#/components/schemas/ACLAction" type: array domain: items: $ref: "#/components/schemas/ACLAction" type: array domainAcceptDelegation: items: $ref: "#/components/schemas/ACLAction" type: array domainAuthCodes: items: $ref: "#/components/schemas/ACLAction" type: array domainCertificate: items: $ref: "#/components/schemas/ACLAction" type: array domainCheckConfig: items: $ref: "#/components/schemas/ACLAction" type: array domainMove: items: $ref: "#/components/schemas/ACLAction" type: array domainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array domainRecord: items: $ref: "#/components/schemas/ACLAction" type: array domainTransferIn: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfig: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigItem: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigToken: items: $ref: "#/components/schemas/ACLAction" type: array endpointVerification: items: $ref: "#/components/schemas/ACLAction" type: array event: items: $ref: "#/components/schemas/ACLAction" type: array fileUpload: items: $ref: "#/components/schemas/ACLAction" type: array gitRepository: items: $ref: "#/components/schemas/ACLAction" type: array integration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationProjects: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationTransfer: items: $ref: "#/components/schemas/ACLAction" type: array integrationVercelConfigurationOverride: items: $ref: "#/components/schemas/ACLAction" type: array ipBlocking: items: $ref: "#/components/schemas/ACLAction" type: array job: items: $ref: "#/components/schemas/ACLAction" type: array logDrain: items: $ref: "#/components/schemas/ACLAction" type: array monitoringChart: items: $ref: "#/components/schemas/ACLAction" type: array monitoringQuery: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainExpire: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainMoved: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainRenewal: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainTransfer: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainUnverified: items: $ref: "#/components/schemas/ACLAction" type: array notificationPaymentFailed: items: $ref: "#/components/schemas/ACLAction" type: array notificationSpendCap: items: $ref: "#/components/schemas/ACLAction" type: array notificationUsageAlert: items: $ref: "#/components/schemas/ACLAction" type: array openTelemetryEndpoint: items: $ref: "#/components/schemas/ACLAction" type: array passwordProtection: items: $ref: "#/components/schemas/ACLAction" type: array paymentMethod: items: $ref: "#/components/schemas/ACLAction" type: array permissions: items: $ref: "#/components/schemas/ACLAction" type: array postgres: items: $ref: "#/components/schemas/ACLAction" type: array previewDeploymentSuffix: items: $ref: "#/components/schemas/ACLAction" type: array proTrialOnboarding: items: $ref: "#/components/schemas/ACLAction" type: array project: items: $ref: "#/components/schemas/ACLAction" type: array projectDeploymentHook: items: $ref: "#/components/schemas/ACLAction" type: array projectDomain: items: $ref: "#/components/schemas/ACLAction" type: array projectDomainMove: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsUnownedByIntegration: items: $ref: "#/components/schemas/ACLAction" type: array projectIntegrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array projectLink: items: $ref: "#/components/schemas/ACLAction" type: array projectMember: items: $ref: "#/components/schemas/ACLAction" type: array projectProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array projectProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array projectTransfer: items: $ref: "#/components/schemas/ACLAction" type: array rateLimit: items: $ref: "#/components/schemas/ACLAction" type: array redis: items: $ref: "#/components/schemas/ACLAction" type: array remoteCaching: items: $ref: "#/components/schemas/ACLAction" type: array samlConfig: items: $ref: "#/components/schemas/ACLAction" type: array secret: items: $ref: "#/components/schemas/ACLAction" type: array sensitiveEnvironmentVariablePolicy: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array spendCapConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array spendCapState: items: $ref: "#/components/schemas/ACLAction" type: array supportCase: items: $ref: "#/components/schemas/ACLAction" type: array supportCaseComment: items: $ref: "#/components/schemas/ACLAction" type: array team: items: $ref: "#/components/schemas/ACLAction" type: array teamAccessRequest: items: $ref: "#/components/schemas/ACLAction" type: array teamFellowMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamInvite: items: $ref: "#/components/schemas/ACLAction" type: array teamInviteCode: items: $ref: "#/components/schemas/ACLAction" type: array teamJoin: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembershipDisconnectSAML: items: $ref: "#/components/schemas/ACLAction" type: array token: items: $ref: "#/components/schemas/ACLAction" type: array usage: items: $ref: "#/components/schemas/ACLAction" type: array user: items: $ref: "#/components/schemas/ACLAction" type: array userConnection: items: $ref: "#/components/schemas/ACLAction" type: array webAnalytics: items: $ref: "#/components/schemas/ACLAction" type: array webAnalyticsPlan: items: $ref: "#/components/schemas/ACLAction" type: array webhook: items: $ref: "#/components/schemas/ACLAction" type: array webhook-event: items: $ref: "#/components/schemas/ACLAction" type: array type: object protectionBypass: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object publicSource: type: - boolean - "null" rootDirectory: type: - string - "null" serverlessFunctionRegion: type: - string - "null" skipGitConnectDuringLink: type: boolean sourceFilesOutsideRootDirectory: type: boolean ssoProtection: properties: deploymentType: enum: - preview - all type: string required: - deploymentType type: - object - "null" targets: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object transferCompletedAt: type: number transferStartedAt: type: number transferToAccountId: type: string transferredFromAccountId: type: string updatedAt: type: number required: - accountId - directoryListing - id - name - nodeVersion type: object type: array required: - projects - pagination type: object description: The paginated list of projects "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Retrieve a list of projects tags: - projects post: description: Allows to create a new project with the provided configuration. It only requires the project `name` but more configuration can be provided to override the defaults. operationId: createProject parameters: - 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: additionalProperties: false properties: buildCommand: description: The build command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" commandForIgnoringBuildStep: maxLength: 256 type: - string - "null" devCommand: description: The dev command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" environmentVariables: description: Collection of ENV Variables the Project will use items: properties: gitBranch: description: The git branch of the environment variable examples: - feature-1 maxLength: 250 type: string key: description: Name of the ENV variable type: string target: description: Deployment Target or Targets in which the ENV variable will be used oneOf: - enum: - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Productio - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Previe - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Developmen - items: enum: - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Productio - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Previe - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Developmen type: array type: description: Type of the ENV variable enum: - system - secret - encrypted - plain type: string value: description: Value for the ENV variable type: string required: - key - value - target type: object type: array framework: description: The framework that is being used for this project. When `null` is used no framework is selected 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 gitRepository: description: The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed properties: repo: description: 'The name of the git repository. For example: \"vercel/next.js\"' type: string type: description: The Git Provider of the repository enum: - github - gitlab - bitbucket required: - type - repo type: object installCommand: description: The install command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" name: description: The desired name for the project examples: - a-project-name maxLength: 100 pattern: ^[a-z0-9]([a-z0-9]|-[a-z0-9])*$ type: string outputDirectory: description: The output directory of the project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" publicSource: description: Specifies whether the source code and logs of the deployments for this project should be public or not type: - boolean - "null" 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 - "null" serverlessFunctionRegion: description: The region to deploy Serverless Functions in this project maxLength: 4 type: - string - "null" skipGitConnectDuringLink: deprecated: true description: Opts-out of the message prompting a CLI user to connect a Git repository in `vercel link`. type: boolean required: - name type: object responses: "200": content: application/json: schema: properties: accountId: type: string analytics: properties: canceledAt: type: - number - "null" disabledAt: type: number enabledAt: type: number id: type: string paidAt: type: number sampleRatePercent: type: - number - "null" spendLimitInDollars: type: - number - "null" required: - id - canceledAt - disabledAt - enabledAt type: object autoExposeSystemEnvs: type: boolean buildCommand: type: - string - "null" commandForIgnoringBuildStep: type: - string - "null" connectBuildsEnabled: type: boolean connectConfigurationId: type: - string - "null" createdAt: type: number devCommand: type: - string - "null" directoryListing: type: boolean enablePreviewFeedback: type: - boolean - "null" env: items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object type: array framework: enum: - 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 type: - string - "null" gitForkProtection: type: boolean gitLFS: type: boolean hasActiveBranches: type: boolean hasFloatingAliases: type: boolean id: type: string installCommand: type: - string - "null" lastRollbackTarget: properties: fromDeploymentId: type: string jobStatus: enum: - succeeded - failed - skipped - pending - in-progress type: string requestedAt: type: number toDeploymentId: type: string required: - fromDeploymentId - toDeploymentId - jobStatus - requestedAt type: - object - "null" latestDeployments: items: properties: alias: items: type: string type: array aliasAssigned: oneOf: - type: number - type: boolean type: "null" aliasError: properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" automaticAliases: items: type: string type: array buildingAt: type: number builds: items: properties: dest: type: string src: type: string use: type: string required: - use type: object type: array checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: type: string createdAt: type: number createdIn: type: string creator: properties: email: type: string githubLogin: type: string gitlabLogin: type: string uid: type: string username: type: string required: - email - uid - username type: - object - "null" deploymentHostname: type: string forced: type: boolean id: type: string meta: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object monorepoManager: type: - string - "null" name: type: string plan: enum: - hobby - enterprise - pro - oss type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean private: type: boolean readyAt: type: number readyState: enum: - BUILDING - ERROR - INITIALIZING - QUEUED - READY - CANCELED type: string requestedAt: type: number target: type: - string - "null" teamId: type: - string - "null" type: enum: - LAMBDAS type: string url: type: string userId: type: string withCache: type: boolean required: - createdAt - createdIn - creator - deploymentHostname - name - id - plan - private - readyState - type - url - userId type: object type: array link: oneOf: - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string org: type: string productionBranch: type: string repo: type: string repoId: type: number sourceless: type: boolean type: enum: - github type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string productionBranch: type: string projectId: type: string projectName: type: string projectNameWithNamespace: type: string projectNamespace: type: string projectUrl: type: string sourceless: type: boolean type: enum: - gitlab type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string name: type: string owner: type: string productionBranch: type: string slug: type: string sourceless: type: boolean type: enum: - bitbucket type: string updatedAt: type: number uuid: type: string workspaceUuid: type: string required: - deployHooks type: object live: type: boolean name: type: string nodeVersion: enum: - 18.x - 16.x - 14.x - 12.x - 10.x type: string outputDirectory: type: - string - "null" passwordProtection: properties: deploymentType: enum: - preview - all type: string required: - deploymentType type: - object - "null" permissions: properties: Monitoring: items: $ref: "#/components/schemas/ACLAction" type: array aliasGlobal: items: $ref: "#/components/schemas/ACLAction" type: array aliasProject: items: $ref: "#/components/schemas/ACLAction" type: array aliasProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array analytics: items: $ref: "#/components/schemas/ACLAction" type: array analyticsSampling: items: $ref: "#/components/schemas/ACLAction" type: array analyticsUsage: items: $ref: "#/components/schemas/ACLAction" type: array auditLog: items: $ref: "#/components/schemas/ACLAction" type: array billingAddress: items: $ref: "#/components/schemas/ACLAction" type: array billingInformation: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoice: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceEmailRecipient: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceLanguage: items: $ref: "#/components/schemas/ACLAction" type: array billingPlan: items: $ref: "#/components/schemas/ACLAction" type: array billingPurchaseOrder: items: $ref: "#/components/schemas/ACLAction" type: array billingTaxId: items: $ref: "#/components/schemas/ACLAction" type: array blob: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifact: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifactUsageEvent: items: $ref: "#/components/schemas/ACLAction" type: array concurrentBuilds: items: $ref: "#/components/schemas/ACLAction" type: array connect: items: $ref: "#/components/schemas/ACLAction" type: array connectConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array connectConfigurationLink: items: $ref: "#/components/schemas/ACLAction" type: array deployment: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheck: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckReRunFromProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPrivate: items: $ref: "#/components/schemas/ACLAction" type: array deploymentProductionGit: items: $ref: "#/components/schemas/ACLAction" type: array deploymentRollback: items: $ref: "#/components/schemas/ACLAction" type: array domain: items: $ref: "#/components/schemas/ACLAction" type: array domainAcceptDelegation: items: $ref: "#/components/schemas/ACLAction" type: array domainAuthCodes: items: $ref: "#/components/schemas/ACLAction" type: array domainCertificate: items: $ref: "#/components/schemas/ACLAction" type: array domainCheckConfig: items: $ref: "#/components/schemas/ACLAction" type: array domainMove: items: $ref: "#/components/schemas/ACLAction" type: array domainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array domainRecord: items: $ref: "#/components/schemas/ACLAction" type: array domainTransferIn: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfig: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigItem: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigToken: items: $ref: "#/components/schemas/ACLAction" type: array endpointVerification: items: $ref: "#/components/schemas/ACLAction" type: array event: items: $ref: "#/components/schemas/ACLAction" type: array fileUpload: items: $ref: "#/components/schemas/ACLAction" type: array gitRepository: items: $ref: "#/components/schemas/ACLAction" type: array integration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationProjects: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationTransfer: items: $ref: "#/components/schemas/ACLAction" type: array integrationVercelConfigurationOverride: items: $ref: "#/components/schemas/ACLAction" type: array ipBlocking: items: $ref: "#/components/schemas/ACLAction" type: array job: items: $ref: "#/components/schemas/ACLAction" type: array logDrain: items: $ref: "#/components/schemas/ACLAction" type: array monitoringChart: items: $ref: "#/components/schemas/ACLAction" type: array monitoringQuery: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainExpire: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainMoved: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainRenewal: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainTransfer: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainUnverified: items: $ref: "#/components/schemas/ACLAction" type: array notificationPaymentFailed: items: $ref: "#/components/schemas/ACLAction" type: array notificationSpendCap: items: $ref: "#/components/schemas/ACLAction" type: array notificationUsageAlert: items: $ref: "#/components/schemas/ACLAction" type: array openTelemetryEndpoint: items: $ref: "#/components/schemas/ACLAction" type: array passwordProtection: items: $ref: "#/components/schemas/ACLAction" type: array paymentMethod: items: $ref: "#/components/schemas/ACLAction" type: array permissions: items: $ref: "#/components/schemas/ACLAction" type: array postgres: items: $ref: "#/components/schemas/ACLAction" type: array previewDeploymentSuffix: items: $ref: "#/components/schemas/ACLAction" type: array proTrialOnboarding: items: $ref: "#/components/schemas/ACLAction" type: array project: items: $ref: "#/components/schemas/ACLAction" type: array projectDeploymentHook: items: $ref: "#/components/schemas/ACLAction" type: array projectDomain: items: $ref: "#/components/schemas/ACLAction" type: array projectDomainMove: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsUnownedByIntegration: items: $ref: "#/components/schemas/ACLAction" type: array projectIntegrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array projectLink: items: $ref: "#/components/schemas/ACLAction" type: array projectMember: items: $ref: "#/components/schemas/ACLAction" type: array projectProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array projectProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array projectTransfer: items: $ref: "#/components/schemas/ACLAction" type: array rateLimit: items: $ref: "#/components/schemas/ACLAction" type: array redis: items: $ref: "#/components/schemas/ACLAction" type: array remoteCaching: items: $ref: "#/components/schemas/ACLAction" type: array samlConfig: items: $ref: "#/components/schemas/ACLAction" type: array secret: items: $ref: "#/components/schemas/ACLAction" type: array sensitiveEnvironmentVariablePolicy: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array spendCapConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array spendCapState: items: $ref: "#/components/schemas/ACLAction" type: array supportCase: items: $ref: "#/components/schemas/ACLAction" type: array supportCaseComment: items: $ref: "#/components/schemas/ACLAction" type: array team: items: $ref: "#/components/schemas/ACLAction" type: array teamAccessRequest: items: $ref: "#/components/schemas/ACLAction" type: array teamFellowMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamInvite: items: $ref: "#/components/schemas/ACLAction" type: array teamInviteCode: items: $ref: "#/components/schemas/ACLAction" type: array teamJoin: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembershipDisconnectSAML: items: $ref: "#/components/schemas/ACLAction" type: array token: items: $ref: "#/components/schemas/ACLAction" type: array usage: items: $ref: "#/components/schemas/ACLAction" type: array user: items: $ref: "#/components/schemas/ACLAction" type: array userConnection: items: $ref: "#/components/schemas/ACLAction" type: array webAnalytics: items: $ref: "#/components/schemas/ACLAction" type: array webAnalyticsPlan: items: $ref: "#/components/schemas/ACLAction" type: array webhook: items: $ref: "#/components/schemas/ACLAction" type: array webhook-event: items: $ref: "#/components/schemas/ACLAction" type: array type: object protectionBypass: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object publicSource: type: - boolean - "null" rootDirectory: type: - string - "null" serverlessFunctionRegion: type: - string - "null" skipGitConnectDuringLink: type: boolean sourceFilesOutsideRootDirectory: type: boolean ssoProtection: properties: deploymentType: enum: - preview - all type: string required: - deploymentType type: - object - "null" targets: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object transferCompletedAt: type: number transferStartedAt: type: number transferToAccountId: type: string transferredFromAccountId: type: string updatedAt: type: number required: - accountId - directoryListing - id - name - nodeVersion type: object description: The project was successfuly created "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The Bitbucket Webhook for the project link could not be created The Gitlab Webhook for the project link could not be created "402": description: |- The account was soft-blocked for an unhandled reason. The account is missing a payment so payment method must be updated "403": description: You do not have permission to access this resource. "409": description: A project with the provided name already exists. security: - bearerToken: [] summary: Create a new project tags: - projects "/v9/projects/{idOrName}": delete: description: Delete a specific project by passing either the project `id` or `name` in the URL. operationId: deleteProject parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "204": description: The project was successfuly removed "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: "" "409": description: "" security: - bearerToken: [] summary: Delete a Project tags: - projects get: description: Get the information for a specific project by passing either the project `id` or `name` in the URL. operationId: getProject parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name oneOf: - type: string - type: boolean - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: accountId: type: string analytics: properties: canceledAt: type: - number - "null" disabledAt: type: number enabledAt: type: number id: type: string paidAt: type: number sampleRatePercent: type: - number - "null" spendLimitInDollars: type: - number - "null" required: - id - canceledAt - disabledAt - enabledAt type: object autoExposeSystemEnvs: type: boolean buildCommand: type: - string - "null" commandForIgnoringBuildStep: type: - string - "null" connectBuildsEnabled: type: boolean connectConfigurationId: type: - string - "null" createdAt: type: number devCommand: type: - string - "null" directoryListing: type: boolean enablePreviewFeedback: type: - boolean - "null" env: items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object type: array framework: enum: - 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 type: - string - "null" gitForkProtection: type: boolean gitLFS: type: boolean hasActiveBranches: type: boolean hasFloatingAliases: type: boolean id: type: string installCommand: type: - string - "null" lastRollbackTarget: properties: fromDeploymentId: type: string jobStatus: enum: - succeeded - failed - skipped - pending - in-progress type: string requestedAt: type: number toDeploymentId: type: string required: - fromDeploymentId - toDeploymentId - jobStatus - requestedAt type: - object - "null" latestDeployments: items: properties: alias: items: type: string type: array aliasAssigned: oneOf: - type: number - type: boolean type: "null" aliasError: properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" automaticAliases: items: type: string type: array buildingAt: type: number builds: items: properties: dest: type: string src: type: string use: type: string required: - use type: object type: array checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: type: string createdAt: type: number createdIn: type: string creator: properties: email: type: string githubLogin: type: string gitlabLogin: type: string uid: type: string username: type: string required: - email - uid - username type: - object - "null" deploymentHostname: type: string forced: type: boolean id: type: string meta: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object monorepoManager: type: - string - "null" name: type: string plan: enum: - hobby - enterprise - pro - oss type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean private: type: boolean readyAt: type: number readyState: enum: - BUILDING - ERROR - INITIALIZING - QUEUED - READY - CANCELED type: string requestedAt: type: number target: type: - string - "null" teamId: type: - string - "null" type: enum: - LAMBDAS type: string url: type: string userId: type: string withCache: type: boolean required: - createdAt - createdIn - creator - deploymentHostname - name - id - plan - private - readyState - type - url - userId type: object type: array link: oneOf: - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string org: type: string productionBranch: type: string repo: type: string repoId: type: number sourceless: type: boolean type: enum: - github type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string productionBranch: type: string projectId: type: string projectName: type: string projectNameWithNamespace: type: string projectNamespace: type: string projectUrl: type: string sourceless: type: boolean type: enum: - gitlab type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string name: type: string owner: type: string productionBranch: type: string slug: type: string sourceless: type: boolean type: enum: - bitbucket type: string updatedAt: type: number uuid: type: string workspaceUuid: type: string required: - deployHooks type: object live: type: boolean name: type: string nodeVersion: enum: - 18.x - 16.x - 14.x - 12.x - 10.x type: string outputDirectory: type: - string - "null" passwordProtection: properties: deploymentType: enum: - preview - all type: string required: - deploymentType type: - object - "null" permissions: properties: Monitoring: items: $ref: "#/components/schemas/ACLAction" type: array aliasGlobal: items: $ref: "#/components/schemas/ACLAction" type: array aliasProject: items: $ref: "#/components/schemas/ACLAction" type: array aliasProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array analytics: items: $ref: "#/components/schemas/ACLAction" type: array analyticsSampling: items: $ref: "#/components/schemas/ACLAction" type: array analyticsUsage: items: $ref: "#/components/schemas/ACLAction" type: array auditLog: items: $ref: "#/components/schemas/ACLAction" type: array billingAddress: items: $ref: "#/components/schemas/ACLAction" type: array billingInformation: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoice: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceEmailRecipient: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceLanguage: items: $ref: "#/components/schemas/ACLAction" type: array billingPlan: items: $ref: "#/components/schemas/ACLAction" type: array billingPurchaseOrder: items: $ref: "#/components/schemas/ACLAction" type: array billingTaxId: items: $ref: "#/components/schemas/ACLAction" type: array blob: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifact: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifactUsageEvent: items: $ref: "#/components/schemas/ACLAction" type: array concurrentBuilds: items: $ref: "#/components/schemas/ACLAction" type: array connect: items: $ref: "#/components/schemas/ACLAction" type: array connectConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array connectConfigurationLink: items: $ref: "#/components/schemas/ACLAction" type: array deployment: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheck: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckReRunFromProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPrivate: items: $ref: "#/components/schemas/ACLAction" type: array deploymentProductionGit: items: $ref: "#/components/schemas/ACLAction" type: array deploymentRollback: items: $ref: "#/components/schemas/ACLAction" type: array domain: items: $ref: "#/components/schemas/ACLAction" type: array domainAcceptDelegation: items: $ref: "#/components/schemas/ACLAction" type: array domainAuthCodes: items: $ref: "#/components/schemas/ACLAction" type: array domainCertificate: items: $ref: "#/components/schemas/ACLAction" type: array domainCheckConfig: items: $ref: "#/components/schemas/ACLAction" type: array domainMove: items: $ref: "#/components/schemas/ACLAction" type: array domainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array domainRecord: items: $ref: "#/components/schemas/ACLAction" type: array domainTransferIn: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfig: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigItem: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigToken: items: $ref: "#/components/schemas/ACLAction" type: array endpointVerification: items: $ref: "#/components/schemas/ACLAction" type: array event: items: $ref: "#/components/schemas/ACLAction" type: array fileUpload: items: $ref: "#/components/schemas/ACLAction" type: array gitRepository: items: $ref: "#/components/schemas/ACLAction" type: array integration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationProjects: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationTransfer: items: $ref: "#/components/schemas/ACLAction" type: array integrationVercelConfigurationOverride: items: $ref: "#/components/schemas/ACLAction" type: array ipBlocking: items: $ref: "#/components/schemas/ACLAction" type: array job: items: $ref: "#/components/schemas/ACLAction" type: array logDrain: items: $ref: "#/components/schemas/ACLAction" type: array monitoringChart: items: $ref: "#/components/schemas/ACLAction" type: array monitoringQuery: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainExpire: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainMoved: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainRenewal: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainTransfer: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainUnverified: items: $ref: "#/components/schemas/ACLAction" type: array notificationPaymentFailed: items: $ref: "#/components/schemas/ACLAction" type: array notificationSpendCap: items: $ref: "#/components/schemas/ACLAction" type: array notificationUsageAlert: items: $ref: "#/components/schemas/ACLAction" type: array openTelemetryEndpoint: items: $ref: "#/components/schemas/ACLAction" type: array passwordProtection: items: $ref: "#/components/schemas/ACLAction" type: array paymentMethod: items: $ref: "#/components/schemas/ACLAction" type: array permissions: items: $ref: "#/components/schemas/ACLAction" type: array postgres: items: $ref: "#/components/schemas/ACLAction" type: array previewDeploymentSuffix: items: $ref: "#/components/schemas/ACLAction" type: array proTrialOnboarding: items: $ref: "#/components/schemas/ACLAction" type: array project: items: $ref: "#/components/schemas/ACLAction" type: array projectDeploymentHook: items: $ref: "#/components/schemas/ACLAction" type: array projectDomain: items: $ref: "#/components/schemas/ACLAction" type: array projectDomainMove: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsUnownedByIntegration: items: $ref: "#/components/schemas/ACLAction" type: array projectIntegrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array projectLink: items: $ref: "#/components/schemas/ACLAction" type: array projectMember: items: $ref: "#/components/schemas/ACLAction" type: array projectProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array projectProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array projectTransfer: items: $ref: "#/components/schemas/ACLAction" type: array rateLimit: items: $ref: "#/components/schemas/ACLAction" type: array redis: items: $ref: "#/components/schemas/ACLAction" type: array remoteCaching: items: $ref: "#/components/schemas/ACLAction" type: array samlConfig: items: $ref: "#/components/schemas/ACLAction" type: array secret: items: $ref: "#/components/schemas/ACLAction" type: array sensitiveEnvironmentVariablePolicy: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array spendCapConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array spendCapState: items: $ref: "#/components/schemas/ACLAction" type: array supportCase: items: $ref: "#/components/schemas/ACLAction" type: array supportCaseComment: items: $ref: "#/components/schemas/ACLAction" type: array team: items: $ref: "#/components/schemas/ACLAction" type: array teamAccessRequest: items: $ref: "#/components/schemas/ACLAction" type: array teamFellowMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamInvite: items: $ref: "#/components/schemas/ACLAction" type: array teamInviteCode: items: $ref: "#/components/schemas/ACLAction" type: array teamJoin: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembershipDisconnectSAML: items: $ref: "#/components/schemas/ACLAction" type: array token: items: $ref: "#/components/schemas/ACLAction" type: array usage: items: $ref: "#/components/schemas/ACLAction" type: array user: items: $ref: "#/components/schemas/ACLAction" type: array userConnection: items: $ref: "#/components/schemas/ACLAction" type: array webAnalytics: items: $ref: "#/components/schemas/ACLAction" type: array webAnalyticsPlan: items: $ref: "#/components/schemas/ACLAction" type: array webhook: items: $ref: "#/components/schemas/ACLAction" type: array webhook-event: items: $ref: "#/components/schemas/ACLAction" type: array type: object protectionBypass: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object publicSource: type: - boolean - "null" rootDirectory: type: - string - "null" serverlessFunctionRegion: type: - string - "null" skipGitConnectDuringLink: type: boolean sourceFilesOutsideRootDirectory: type: boolean ssoProtection: properties: deploymentType: enum: - preview - all type: string required: - deploymentType type: - object - "null" targets: additionalProperties: description: An object containing the deployment's metadata examples: - foo: bar type: string description: An object containing the deployment's metadata examples: - foo: bar type: object transferCompletedAt: type: number transferStartedAt: type: number transferToAccountId: type: string transferredFromAccountId: type: string updatedAt: type: number required: - accountId - directoryListing - id - name - nodeVersion type: object description: The project information "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The project could not be found security: - bearerToken: [] summary: Find a project by id or name tags: - projects patch: description: Update the fields of a project using either its `name` or `id`. operationId: updateProject parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - 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: additionalProperties: false properties: autoExposeSystemEnvs: type: boolean buildCommand: description: The build command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" commandForIgnoringBuildStep: maxLength: 256 type: - string - "null" devCommand: description: The dev command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" directoryListing: type: boolean enablePreviewFeedback: description: Opt-in to Preview comments on the project level type: - boolean - "null" framework: description: The framework that is being used for this project. When `null` is used no framework is selected 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 type: - string - "null" gitForkProtection: description: Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed type: boolean gitLFS: description: Specifies whether Git LFS is enabled for this project. type: boolean installCommand: description: The install command for this project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" name: description: The desired name for the project examples: - a-project-name maxLength: 100 pattern: ^[a-z0-9]([a-z0-9]|-[a-z0-9])*$ type: string nodeVersion: enum: - 18.x - 16.x - 14.x - 12.x - 10.x type: string outputDirectory: description: The output directory of the project. When `null` is used this value will be automatically detected maxLength: 256 type: - string - "null" passwordProtection: additionalProperties: false description: Allows to protect project deployments with a password properties: deploymentType: description: Specify if the password will apply to every Deployment Target or just Preview enum: - all - preview type: string password: description: The password that will be used to protect Project Deployments maxLength: 72 type: - string - "null" required: - deploymentType type: - object - "null" publicSource: description: Specifies whether the source code and logs of the deployments for this project should be public or not type: - boolean - "null" 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 - "null" serverlessFunctionRegion: description: The region to deploy Serverless Functions in this project maxLength: 4 type: - string - "null" skipGitConnectDuringLink: deprecated: true description: Opts-out of the message prompting a CLI user to connect a Git repository in `vercel link`. type: boolean sourceFilesOutsideRootDirectory: description: Indicates if there are source files outside of the root directory type: boolean ssoProtection: additionalProperties: false description: Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team properties: deploymentType: default: preview description: Specify if the Vercel Authentication (SSO Protection) will apply to every Deployment Target or just Preview enum: - all - preview type: string required: - deploymentType type: - object - "null" type: object responses: "200": content: application/json: schema: properties: accountId: type: string analytics: properties: canceledAt: type: - number - "null" disabledAt: type: number enabledAt: type: number id: type: string paidAt: type: number sampleRatePercent: type: - number - "null" spendLimitInDollars: type: - number - "null" required: - id - canceledAt - disabledAt - enabledAt type: object autoExposeSystemEnvs: type: boolean buildCommand: type: - string - "null" commandForIgnoringBuildStep: type: - string - "null" connectBuildsEnabled: type: boolean connectConfigurationId: type: - string - "null" createdAt: type: number devCommand: type: - string - "null" directoryListing: type: boolean enablePreviewFeedback: type: - boolean - "null" env: items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object type: array framework: enum: - 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 type: - string - "null" gitForkProtection: type: boolean gitLFS: type: boolean hasActiveBranches: type: boolean hasFloatingAliases: type: boolean id: type: string installCommand: type: - string - "null" lastRollbackTarget: properties: fromDeploymentId: type: string jobStatus: enum: - succeeded - failed - skipped - pending - in-progress type: string requestedAt: type: number toDeploymentId: type: string required: - fromDeploymentId - toDeploymentId - jobStatus - requestedAt type: - object - "null" latestDeployments: items: properties: alias: items: type: string type: array aliasAssigned: oneOf: - type: number - type: boolean type: "null" aliasError: properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" automaticAliases: items: type: string type: array buildingAt: type: number builds: items: properties: dest: type: string src: type: string use: type: string required: - use type: object type: array checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: type: string createdAt: type: number createdIn: type: string creator: properties: email: type: string githubLogin: type: string gitlabLogin: type: string uid: type: string username: type: string required: - email - uid - username type: - object - "null" deploymentHostname: type: string forced: type: boolean id: type: string meta: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object monorepoManager: type: - string - "null" name: type: string plan: enum: - hobby - enterprise - pro - oss type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean private: type: boolean readyAt: type: number readyState: enum: - BUILDING - ERROR - INITIALIZING - QUEUED - READY - CANCELED type: string requestedAt: type: number target: type: - string - "null" teamId: type: - string - "null" type: enum: - LAMBDAS type: string url: type: string userId: type: string withCache: type: boolean required: - createdAt - createdIn - creator - deploymentHostname - name - id - plan - private - readyState - type - url - userId type: object type: array link: oneOf: - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string org: type: string productionBranch: type: string repo: type: string repoId: type: number sourceless: type: boolean type: enum: - github type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string productionBranch: type: string projectId: type: string projectName: type: string projectNameWithNamespace: type: string projectNamespace: type: string projectUrl: type: string sourceless: type: boolean type: enum: - gitlab type: string updatedAt: type: number required: - deployHooks type: object - properties: createdAt: type: number deployHooks: items: properties: createdAt: type: number id: type: string name: type: string ref: type: string url: type: string required: - id - name - ref - url type: object type: array gitCredentialId: type: string name: type: string owner: type: string productionBranch: type: string slug: type: string sourceless: type: boolean type: enum: - bitbucket type: string updatedAt: type: number uuid: type: string workspaceUuid: type: string required: - deployHooks type: object live: type: boolean name: type: string nodeVersion: enum: - 18.x - 16.x - 14.x - 12.x - 10.x type: string outputDirectory: type: - string - "null" passwordProtection: properties: deploymentType: enum: - all - preview type: string required: - deploymentType type: - object - "null" permissions: properties: Monitoring: items: $ref: "#/components/schemas/ACLAction" type: array aliasGlobal: items: $ref: "#/components/schemas/ACLAction" type: array aliasProject: items: $ref: "#/components/schemas/ACLAction" type: array aliasProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array analytics: items: $ref: "#/components/schemas/ACLAction" type: array analyticsSampling: items: $ref: "#/components/schemas/ACLAction" type: array analyticsUsage: items: $ref: "#/components/schemas/ACLAction" type: array auditLog: items: $ref: "#/components/schemas/ACLAction" type: array billingAddress: items: $ref: "#/components/schemas/ACLAction" type: array billingInformation: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoice: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceEmailRecipient: items: $ref: "#/components/schemas/ACLAction" type: array billingInvoiceLanguage: items: $ref: "#/components/schemas/ACLAction" type: array billingPlan: items: $ref: "#/components/schemas/ACLAction" type: array billingPurchaseOrder: items: $ref: "#/components/schemas/ACLAction" type: array billingTaxId: items: $ref: "#/components/schemas/ACLAction" type: array blob: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifact: items: $ref: "#/components/schemas/ACLAction" type: array cacheArtifactUsageEvent: items: $ref: "#/components/schemas/ACLAction" type: array concurrentBuilds: items: $ref: "#/components/schemas/ACLAction" type: array connect: items: $ref: "#/components/schemas/ACLAction" type: array connectConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array connectConfigurationLink: items: $ref: "#/components/schemas/ACLAction" type: array deployment: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheck: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentCheckReRunFromProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPreview: items: $ref: "#/components/schemas/ACLAction" type: array deploymentPrivate: items: $ref: "#/components/schemas/ACLAction" type: array deploymentProductionGit: items: $ref: "#/components/schemas/ACLAction" type: array deploymentRollback: items: $ref: "#/components/schemas/ACLAction" type: array domain: items: $ref: "#/components/schemas/ACLAction" type: array domainAcceptDelegation: items: $ref: "#/components/schemas/ACLAction" type: array domainAuthCodes: items: $ref: "#/components/schemas/ACLAction" type: array domainCertificate: items: $ref: "#/components/schemas/ACLAction" type: array domainCheckConfig: items: $ref: "#/components/schemas/ACLAction" type: array domainMove: items: $ref: "#/components/schemas/ACLAction" type: array domainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array domainRecord: items: $ref: "#/components/schemas/ACLAction" type: array domainTransferIn: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfig: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigItem: items: $ref: "#/components/schemas/ACLAction" type: array edgeConfigToken: items: $ref: "#/components/schemas/ACLAction" type: array endpointVerification: items: $ref: "#/components/schemas/ACLAction" type: array event: items: $ref: "#/components/schemas/ACLAction" type: array fileUpload: items: $ref: "#/components/schemas/ACLAction" type: array gitRepository: items: $ref: "#/components/schemas/ACLAction" type: array integration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationProjects: items: $ref: "#/components/schemas/ACLAction" type: array integrationConfigurationTransfer: items: $ref: "#/components/schemas/ACLAction" type: array integrationVercelConfigurationOverride: items: $ref: "#/components/schemas/ACLAction" type: array ipBlocking: items: $ref: "#/components/schemas/ACLAction" type: array job: items: $ref: "#/components/schemas/ACLAction" type: array logDrain: items: $ref: "#/components/schemas/ACLAction" type: array monitoringChart: items: $ref: "#/components/schemas/ACLAction" type: array monitoringQuery: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainExpire: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainMoved: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainPurchase: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainRenewal: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainTransfer: items: $ref: "#/components/schemas/ACLAction" type: array notificationDomainUnverified: items: $ref: "#/components/schemas/ACLAction" type: array notificationPaymentFailed: items: $ref: "#/components/schemas/ACLAction" type: array notificationSpendCap: items: $ref: "#/components/schemas/ACLAction" type: array notificationUsageAlert: items: $ref: "#/components/schemas/ACLAction" type: array openTelemetryEndpoint: items: $ref: "#/components/schemas/ACLAction" type: array passwordProtection: items: $ref: "#/components/schemas/ACLAction" type: array paymentMethod: items: $ref: "#/components/schemas/ACLAction" type: array permissions: items: $ref: "#/components/schemas/ACLAction" type: array postgres: items: $ref: "#/components/schemas/ACLAction" type: array previewDeploymentSuffix: items: $ref: "#/components/schemas/ACLAction" type: array proTrialOnboarding: items: $ref: "#/components/schemas/ACLAction" type: array project: items: $ref: "#/components/schemas/ACLAction" type: array projectDeploymentHook: items: $ref: "#/components/schemas/ACLAction" type: array projectDomain: items: $ref: "#/components/schemas/ACLAction" type: array projectDomainMove: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array projectEnvVarsUnownedByIntegration: items: $ref: "#/components/schemas/ACLAction" type: array projectIntegrationConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array projectLink: items: $ref: "#/components/schemas/ACLAction" type: array projectMember: items: $ref: "#/components/schemas/ACLAction" type: array projectProductionBranch: items: $ref: "#/components/schemas/ACLAction" type: array projectProtectionBypass: items: $ref: "#/components/schemas/ACLAction" type: array projectTransfer: items: $ref: "#/components/schemas/ACLAction" type: array rateLimit: items: $ref: "#/components/schemas/ACLAction" type: array redis: items: $ref: "#/components/schemas/ACLAction" type: array remoteCaching: items: $ref: "#/components/schemas/ACLAction" type: array samlConfig: items: $ref: "#/components/schemas/ACLAction" type: array secret: items: $ref: "#/components/schemas/ACLAction" type: array sensitiveEnvironmentVariablePolicy: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVars: items: $ref: "#/components/schemas/ACLAction" type: array sharedEnvVarsProduction: items: $ref: "#/components/schemas/ACLAction" type: array spendCapConfiguration: items: $ref: "#/components/schemas/ACLAction" type: array spendCapState: items: $ref: "#/components/schemas/ACLAction" type: array supportCase: items: $ref: "#/components/schemas/ACLAction" type: array supportCaseComment: items: $ref: "#/components/schemas/ACLAction" type: array team: items: $ref: "#/components/schemas/ACLAction" type: array teamAccessRequest: items: $ref: "#/components/schemas/ACLAction" type: array teamFellowMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamInvite: items: $ref: "#/components/schemas/ACLAction" type: array teamInviteCode: items: $ref: "#/components/schemas/ACLAction" type: array teamJoin: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembership: items: $ref: "#/components/schemas/ACLAction" type: array teamOwnMembershipDisconnectSAML: items: $ref: "#/components/schemas/ACLAction" type: array token: items: $ref: "#/components/schemas/ACLAction" type: array usage: items: $ref: "#/components/schemas/ACLAction" type: array user: items: $ref: "#/components/schemas/ACLAction" type: array userConnection: items: $ref: "#/components/schemas/ACLAction" type: array webAnalytics: items: $ref: "#/components/schemas/ACLAction" type: array webAnalyticsPlan: items: $ref: "#/components/schemas/ACLAction" type: array webhook: items: $ref: "#/components/schemas/ACLAction" type: array webhook-event: items: $ref: "#/components/schemas/ACLAction" type: array type: object protectionBypass: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object publicSource: type: - boolean - "null" rootDirectory: type: - string - "null" serverlessFunctionRegion: type: - string - "null" skipGitConnectDuringLink: type: boolean sourceFilesOutsideRootDirectory: type: boolean ssoProtection: properties: deploymentType: enum: - all - preview type: string required: - deploymentType type: - object - "null" targets: additionalProperties: properties: alias: items: type: string type: array aliasAssigned: oneOf: - type: number - type: boolean type: "null" aliasError: properties: code: type: string message: type: string required: - code - message type: - object - "null" aliasFinal: type: - string - "null" automaticAliases: items: type: string type: array buildingAt: type: number builds: items: properties: dest: type: string src: type: string use: type: string required: - use type: object type: array checksConclusion: enum: - succeeded - failed - skipped - canceled type: string checksState: enum: - registered - running - completed type: string connectConfigurationId: type: string createdAt: type: number createdIn: type: string creator: properties: email: type: string githubLogin: type: string gitlabLogin: type: string uid: type: string username: type: string required: - email - uid - username type: - object - "null" deploymentHostname: type: string forced: type: boolean id: type: string meta: additionalProperties: type: string description: Construct a type with a set of properties K of type T type: object monorepoManager: type: - string - "null" name: type: string plan: enum: - hobby - enterprise - pro - oss type: string previewCommentsEnabled: description: Whether or not preview comments are enabled for the deployment examples: - false type: boolean private: type: boolean readyAt: type: number readyState: enum: - BUILDING - ERROR - INITIALIZING - QUEUED - READY - CANCELED type: string requestedAt: type: number target: type: - string - "null" teamId: type: - string - "null" type: enum: - LAMBDAS type: string url: type: string userId: type: string withCache: type: boolean required: - createdAt - createdIn - creator - deploymentHostname - name - id - plan - private - readyState - type - url - userId type: - object - "null" type: object transferCompletedAt: type: number transferStartedAt: type: number transferToAccountId: type: string transferredFromAccountId: type: string updatedAt: type: number required: - accountId - directoryListing - id - name - nodeVersion type: object description: The project was succesfuly updated "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. Owner does not have protection add-on Advanced Deployment Protection is not available for the user plan "403": description: You do not have permission to access this resource. "404": description: The project was not found "409": description: |- The provided name for the project is already being used The project is currently being transferred. security: - bearerToken: [] summary: Update an existing project tags: - projects "/v9/projects/{idOrName}/domains": get: description: Retrieve the domains associated with a given project by passing either the project `id` or `name` in the URL. operationId: getProjectDomains parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name oneOf: - type: string - type: integer - description: Filters only production domains when set to `true`. in: query name: production required: false schema: default: "false" description: Filters only production domains when set to `true`. enum: - "true" - "false" - description: Filters domains based on specific branch. in: query name: gitBranch required: false schema: description: Filters domains based on specific branch. type: string - description: Excludes redirect project domains when \"false\". Includes redirect project domains when \"true\" (default). in: query name: redirects required: false schema: default: "true" description: Excludes redirect project domains when \"false\". Includes redirect project domains when \"true\" (default). enum: - "true" - "false" - description: Filters domains based on their redirect target. in: query name: redirect required: false schema: description: Filters domains based on their redirect target. examples: - example.com type: string - description: Filters domains based on their verification status. in: query name: verified required: false schema: description: Filters domains based on their verification status. enum: - "true" - "false" - description: Maximum number of domains to list from a request (max 100). in: query name: limit required: false schema: description: Maximum number of domains to list from a request (max 100). examples: - 20 type: number - description: Get domains created after this JavaScript timestamp. in: query name: since required: false schema: description: Get domains created after this JavaScript timestamp. examples: - 1609499532000 type: number - description: Get domains created before this JavaScript timestamp. in: query name: until required: false schema: description: Get domains created before this JavaScript timestamp. examples: - 1612264332000 type: number - description: Domains sort order by createdAt in: query name: order required: false schema: default: DESC description: Domains sort order by createdAt enum: - ASC - DESC - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: domains: items: properties: apexName: type: string createdAt: type: number gitBranch: type: - string - "null" name: type: string projectId: type: string redirect: type: - string - "null" redirectStatusCode: enum: - 307 - 301 - 302 - 308 type: - number - "null" updatedAt: type: number verification: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." items: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." properties: domain: type: string reason: type: string type: type: string value: type: string required: - type - domain - value - reason type: object type: array verified: description: "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed." type: boolean required: - name - apexName - projectId - verified type: object type: array pagination: $ref: "#/components/schemas/Pagination" required: - domains - pagination type: object description: Successful response retrieving a list of domains "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: Project not found security: - bearerToken: [] summary: Retrieve project domains by project by id or name tags: - projects "/v9/projects/{idOrName}/domains/{domain}": delete: description: Remove a domain from a project by passing the domain name and by specifying the project by either passing the project `id` or `name` in the URL. operationId: removeProjectDomain parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name type: string - description: The project domain name in: path name: domain required: true schema: description: The project domain name examples: - www.example.com type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: type: object description: The domain was succesfully removed from the project "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: Project not found "409": description: The project is currently being transferred security: - bearerToken: [] summary: Remove a domain from a project tags: - projects get: description: Get project domain by project id/name and domain name. operationId: getProjectDomain parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name type: string - description: The project domain name in: path name: domain required: true schema: description: The project domain name examples: - www.example.com type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: apexName: type: string createdAt: type: number gitBranch: type: - string - "null" name: type: string projectId: type: string redirect: type: - string - "null" redirectStatusCode: enum: - 307 - 301 - 302 - 308 type: - number - "null" updatedAt: type: number verification: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." items: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." properties: domain: type: string reason: type: string type: type: string value: type: string required: - type - domain - value - reason type: object type: array verified: description: "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed." type: boolean required: - name - apexName - projectId - verified type: object description: "" "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: Project not found security: - bearerToken: [] summary: Get a project domain tags: - projects patch: description: Update a project domain's configuration, including the name, git branch and redirect of the domain. operationId: updateProjectDomain parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name type: string - description: The project domain name in: path name: domain required: true schema: description: The project domain name examples: - www.example.com type: string - 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: properties: gitBranch: description: Git branch to link the project domain examples: - null maxLength: 250 type: - string - "null" redirect: description: Target destination domain for redirect examples: - foobar.com type: - string - "null" redirectStatusCode: description: Status code for domain redirect enum: - null - 301 - 302 - 307 - 308 examples: - 307 type: - integer - "null" type: object responses: "200": content: application/json: schema: properties: apexName: type: string createdAt: type: number gitBranch: type: - string - "null" name: type: string projectId: type: string redirect: type: - string - "null" redirectStatusCode: enum: - 307 - 301 - 302 - 308 type: - number - "null" updatedAt: type: number verification: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." items: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." properties: domain: type: string reason: type: string type: type: string value: type: string required: - type - domain - value - reason type: object type: array verified: description: "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed." type: boolean required: - name - apexName - projectId - verified type: object description: The domain was updated successfuly "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. The domain redirect is not valid "403": description: You do not have permission to access this resource. "404": description: The project was not found "409": description: The project is currently being transferred security: - bearerToken: [] summary: Update a project domain tags: - projects "/v9/projects/{idOrName}/domains/{domain}/verify": post: description: Attempts to verify a project domain with `verified = false` by checking the correctness of the project domain's `verification` challenge. operationId: verifyProjectDomain parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB type: string - description: The domain name you want to verify in: path name: domain required: true schema: description: The domain name you want to verify examples: - example.com type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: properties: apexName: type: string createdAt: type: number gitBranch: type: - string - "null" name: type: string projectId: type: string redirect: type: - string - "null" redirectStatusCode: enum: - 307 - 301 - 302 - 308 type: - number - "null" updatedAt: type: number verification: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." items: description: "A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`." properties: domain: type: string reason: type: string type: type: string value: type: string required: - type - domain - value - reason type: object type: array verified: description: "`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed." type: boolean required: - name - apexName - projectId - verified type: object description: |- The project domain was verified successfully Domain is already verified "400": description: |- One of the provided values in the request query is invalid. There is an existing TXT record on the domain verifying it for another project The domain does not have a TXT record that attempts to verify the project domain The TXT record on the domain does not match the expected challenge for the project domain Project domain is not assigned to project Project domain does not exist "403": description: You do not have permission to access this resource. security: - bearerToken: [] summary: Verify project domain tags: - projects "/v9/projects/{idOrName}/env": get: description: Retrieve the environment variables for a given project by passing either the project `id` or `name` in the URL. operationId: filterProjectEnvs parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA type: string - description: If defined, the git branch of the environment variable to filter the results in: query name: gitBranch required: false schema: description: If defined, the git branch of the environment variable to filter the results examples: - feature-1 maxLength: 250 type: string - description: If true, the environment variable value will be decrypted in: query name: decrypt required: false schema: deprecated: true description: If true, the environment variable value will be decrypted enum: - "true" - "false" examples: - "true" type: string - description: The source that is calling the endpoint. in: query name: source required: false schema: description: The source that is calling the endpoint. examples: - vercel-cli:pull type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string system: type: boolean target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string type: object - properties: envs: items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string system: type: boolean target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string type: object type: array pagination: $ref: "#/components/schemas/Pagination" required: - envs - pagination type: object - description: The list of environment variables for the given project properties: envs: items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string system: type: boolean target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string type: object type: array required: - envs type: object description: The list of environment variables for the given project "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: The project could not be found security: - bearerToken: [] summary: Retrieve the environment variables of a project by id or name tags: - projects "/v9/projects/{idOrName}/env/{id}": delete: description: Delete a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL. operationId: removeProjectEnv parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA type: string - description: The unique environment variable identifier in: path name: id required: true schema: description: The unique environment variable identifier examples: - XMbOEya1gUUO1ir4 type: string - description: The Team identifier or slug to perform the request on behalf of. in: query name: teamId schema: type: string responses: "200": content: application/json: schema: oneOf: - items: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object type: array - properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string system: type: boolean target: oneOf: - items: enum: - production - preview - development - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object - properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development - preview - development type: string type: enum: - secret - system - encrypted - plain - sensitive type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object description: The environment variable was successfully removed "400": description: One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: |- The environment variable could not be found The project could not be found "409": description: The project is being transfered and removing an environment variable is not possible security: - bearerToken: [] summary: Remove an environment variable tags: - projects patch: description: Edit a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL. operationId: editProjectEnv parameters: - description: The unique project identifier or the project name in: path name: idOrName required: true schema: description: The unique project identifier or the project name examples: - prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA type: string - description: The unique environment variable identifier in: path name: id required: true schema: description: The unique environment variable identifier examples: - XMbOEya1gUUO1ir4 type: string - 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: additionalProperties: false properties: gitBranch: description: The git branch of the environment variable examples: - feature-1 maxLength: 250 type: - string - "null" key: description: The name of the environment variable examples: - GITHUB_APP_ID type: string target: description: The target environment of the environment variable examples: - - preview items: enum: - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Productio - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Previe - mport("/vercel/path0/utils/env-variable-util/types").EnvTarget.Developmen type: array type: description: The type of environment variable enum: - system - secret - encrypted - plain - sensitive examples: - plain type: string value: description: The value of the environment variable examples: - bkWIjbnxcvo78 type: string type: object responses: "200": content: application/json: schema: properties: configurationId: type: - string - "null" createdAt: type: number createdBy: type: - string - "null" decrypted: description: Whether `value` is decrypted. type: boolean edgeConfigId: type: - string - "null" edgeConfigTokenId: type: - string - "null" gitBranch: type: string id: type: string key: type: string target: oneOf: - items: enum: - production - preview - development - preview - development type: string type: array - enum: - production - preview - development - preview - development type: string type: enum: - system - encrypted - plain - sensitive - secret type: string updatedAt: type: number updatedBy: type: - string - "null" value: type: string required: - type - key - value type: object description: The environment variable was successfully edited "400": description: |- One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. "403": description: You do not have permission to access this resource. "404": description: |- The environment variable could not be found The project could not be found "409": description: The project is being transfered and removing an environment variable is not possible security: - bearerToken: [] summary: Edit an environment variable tags: - projects components: schemas: ACLAction: description: Enum containing the actions that can be performed against a resource. Group operations are included. enum: - create - delete - read - update - list - count type: string AuthToken: description: Authentication token metadata. properties: activeAt: description: Timestamp (in milliseconds) of when the token was most recently used. examples: - 1632816536002 type: number createdAt: description: Timestamp (in milliseconds) of when the token was created. examples: - 1632816536002 type: number expiresAt: description: Timestamp (in milliseconds) of when the token expires. examples: - 1632816536002 type: number id: description: The unique identifier of the token. examples: - 5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391 type: string name: description: The human-readable name of the token. type: string origin: description: The origin of how the token was created. examples: - github type: string scopes: description: The access scopes granted to the token. items: oneOf: - description: The access scopes granted to the token. properties: createdAt: type: number expiresAt: type: number origin: enum: - saml - github - gitlab - bitbucket - email - manual type: string type: enum: - user type: string required: - type - origin - createdAt type: object - description: The access scopes granted to the token. properties: createdAt: type: number expiresAt: type: number origin: enum: - saml - github - gitlab - bitbucket - email - manual type: string teamId: type: string type: enum: - team type: string required: - type - teamId - origin - createdAt type: object type: array type: description: The type of the token. examples: - oauth2-token type: string required: - id - name - type - activeAt - createdAt type: object AuthUser: description: Data for the currently authenticated User. properties: activeDashboardViews: description: set of dashboard view preferences (cards or list) per scopeId items: description: set of dashboard view preferences (cards or list) per scopeId properties: scopeId: type: string viewPreference: enum: - cards - list type: string required: - scopeId - viewPreference type: object type: array avatar: description: SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. examples: - 22cb30c85ff45ac4c72de8981500006b28114aa1 type: - string - "null" billing: description: An object containing billing infomation associated with the User account. properties: addons: items: enum: - custom-deployment-suffix - live-support type: string type: - array - "null" address: properties: city: type: string country: type: string line1: type: string line2: type: string postalCode: type: string state: type: string required: - line1 type: - object - "null" cancelation: type: - number - "null" contract: properties: end: type: number start: type: number required: - start - end type: - object - "null" controls: properties: analyticsSampleRateInPercent: type: - number - "null" analyticsSpendLimitInDollars: type: - number - "null" type: - object - "null" currency: enum: - usd - eur type: string email: type: - string - "null" invoiceItems: properties: analytics: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object analyticsUsage: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object artifacts: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object bandwidth: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object builds: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object concurrentBuilds: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object cronJobInvocation: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object customCerts: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object edgeConfigRead: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object edgeConfigWrite: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object edgeFunctionExecutionUnits: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object edgeMiddlewareInvocations: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object enterprise: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object monitoring: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object monitoringMetric: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object passwordProtection: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object previewDeploymentSuffix: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object pro: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object saml: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object serverlessFunctionExecution: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object sourceImages: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object ssoProtection: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object teamSeats: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object webAnalytics: description: "Will be used to create an invoice item. The price must be in cents: 2000 for $20." properties: createdAt: type: number disabledAt: type: - number - "null" frequency: properties: interval: enum: - month type: string intervalCount: enum: - 1 - 3 - 2 - 6 - 12 type: number required: - interval - intervalCount type: object hidden: type: boolean maxQuantity: type: number name: type: string price: type: number quantity: type: number tier: type: number required: - price - quantity - hidden type: object webAnalyticsEvent: properties: batch: type: number disabledAt: type: - number - "null" hidden: type: boolean name: type: string price: type: number threshold: type: number tier: type: number required: - price - batch - threshold - hidden type: object type: - object - "null" invoiceSettings: properties: footer: type: string type: object language: type: - string - "null" name: type: - string - "null" orbCustomerId: type: string overdue: type: - boolean - "null" period: properties: end: type: number start: type: number required: - start - end type: - object - "null" plan: enum: - hobby - enterprise - pro type: string platform: enum: - stripe - stripeTestMode type: string pricingExperiment: enum: - august-2022 type: string programType: enum: - startup - agency type: string purchaseOrder: type: - string - "null" status: enum: - active - canceled - trialing - overdue - expired type: string subscriptions: items: properties: discount: properties: coupon: properties: amountOff: type: - number - "null" duration: enum: - forever - repeating - once type: string durationInMonths: type: - number - "null" id: type: string name: type: - string - "null" percentageOff: type: - number - "null" required: - id - name - amountOff - percentageOff - durationInMonths - duration type: object id: type: string required: - id - coupon type: - object - "null" frequency: properties: interval: enum: - month - day - week - year type: string intervalCount: type: number required: - interval - intervalCount type: object id: type: string items: items: properties: amount: type: number id: type: string priceId: type: string productId: type: string quantity: type: number required: - id - priceId - productId - amount - quantity type: object type: array period: properties: end: type: number start: type: number required: - start - end type: object trial: properties: end: type: number start: type: number required: - start - end type: - object - "null" required: - id - trial - period - frequency - discount - items type: object type: - array - "null" tax: properties: id: type: string type: type: string required: - type - id type: - object - "null" trial: properties: end: type: number start: type: number required: - start - end type: - object - "null" required: - period - plan type: - object - "null" createdAt: description: UNIX timestamp (in milliseconds) when the User account was created. examples: - 1630748523395 type: number dismissedToasts: description: A record of when, under a certain scopeId, a toast was dismissed items: description: A record of when, under a certain scopeId, a toast was dismissed properties: dismissals: items: properties: createdAt: type: number scopeId: type: string required: - scopeId - createdAt type: object type: array name: type: string required: - name - dismissals type: object type: array email: description: Email address associated with the User account. examples: - me@example.com type: string favoriteProjects: description: A list of projects across teams that a user has marked as a favorite. items: description: A list of projects across teams that a user has marked as a favorite. properties: projectId: type: string scopeId: type: string scopeSlug: type: string required: - projectId - scopeId - scopeSlug type: object type: array hasTrialAvailable: description: Whether the user has a trial available for a paid plan subscription. type: boolean id: description: The User's unique identifier. examples: - AEIIDYVk59zbFF2Sxfyxxmua type: string importFlowGitNamespace: oneOf: - type: string - type: number type: "null" importFlowGitNamespaceId: oneOf: - type: string - type: number type: "null" importFlowGitProvider: enum: - github - gitlab - bitbucket type: string name: description: Name associated with the User account, or `null` if none has been provided. examples: - John Doe type: - string - "null" preferredScopesAndGitNamespaces: items: properties: gitNamespaceId: oneOf: - type: string - type: number type: "null" scopeId: type: string required: - scopeId - gitNamespaceId type: object type: array remoteCaching: description: remote caching settings properties: enabled: type: boolean type: object resourceConfig: description: An object containing infomation related to the amount of platform resources may be allocated to the User account. properties: awsAccountIds: items: type: string type: array awsAccountType: type: string cfZoneName: type: string concurrentBuilds: type: number edgeConfigSize: description: To overwrite the maximum size of an Edge Config per account. Size is in kilobytes, eg 64 leads to 64kB or 64_000 bytes worth of storage type: number edgeConfigs: description: To overwrite the number of Edge Configs an account can create. type: number nodeType: type: string type: object softBlock: description: When the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why. properties: blockedAt: type: number reason: enum: - FAIR_USE_LIMITS_EXCEEDED - ENTERPRISE_TRIAL_ENDED - BLOCKED_FOR_PLATFORM_ABUSE - UNPAID_INVOICE - SUBSCRIPTION_EXPIRED - SUBSCRIPTION_CANCELED type: string required: - blockedAt - reason type: - object - "null" stagingPrefix: description: Prefix that will be used in the URL of "Preview" deployments created by the User account. type: string username: description: Unique username associated with the User account. examples: - jdoe type: string required: - createdAt - softBlock - billing - resourceConfig - stagingPrefix - hasTrialAvailable - id - email - name - username - avatar type: object AuthUserLimited: description: A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data. properties: avatar: description: SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. examples: - 22cb30c85ff45ac4c72de8981500006b28114aa1 type: - string - "null" email: description: Email address associated with the User account. examples: - me@example.com type: string id: description: The User's unique identifier. examples: - AEIIDYVk59zbFF2Sxfyxxmua type: string limited: description: Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges. type: boolean name: description: Name associated with the User account, or `null` if none has been provided. examples: - John Doe type: - string - "null" username: description: Unique username associated with the User account. examples: - jdoe type: string required: - limited - id - email - name - username - avatar type: object EdgeConfigItem: description: The EdgeConfig. properties: createdAt: type: number edgeConfigId: type: string key: type: string updatedAt: type: number value: $ref: "#/components/schemas/EdgeConfigItemValue" required: - key - value - edgeConfigId - createdAt - updatedAt type: object EdgeConfigItemValue: oneOf: - type: string - type: number - type: boolean - type: object - items: $ref: "#/components/schemas/EdgeConfigItemValue" type: array type: "null" EdgeConfigToken: description: The EdgeConfig. properties: createdAt: type: number edgeConfigId: type: string id: description: This is not the token itself, but rather an id to identify the token by type: string label: type: string token: type: string required: - token - label - id - edgeConfigId - createdAt type: object FileTree: description: A deployment file tree entry properties: children: description: The list of children files of the directory (only valid for the `directory` type) items: $ref: "#/components/schemas/FileTree" type: array contentType: description: The content-type of the file (only valid for the `file` type) examples: - application/json type: string mode: description: The file "mode" indicating file type and permissions. type: number name: description: The name of the file tree entry examples: - my-file.json type: string symlink: description: Not currently used. See `file-list-to-tree.ts`. type: string type: description: String indicating the type of file tree entry. enum: - directory - file - symlink - lambda - middleware - invalid examples: - file type: string uid: description: The unique identifier of the file (only valid for the `file` type) examples: - 2d4aad419917f15b1146e9e03ddc9bb31747e4d0 type: string required: - name - type - mode type: object Pagination: description: This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data. properties: count: description: Amount of items in the current page. examples: - 20 type: number next: description: Timestamp that must be used to request the next page. examples: - 1540095775951 type: - number - "null" prev: description: Timestamp that must be used to request the previous page. examples: - 1540095775951 type: - number - "null" required: - count - next - prev type: object Team: description: Data representing a Team. type: object TeamLimited: description: A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data. properties: avatar: description: The ID of the file used as avatar for this Team. examples: - 6eb07268bcfadd309905ffb1579354084c24655c type: - string - "null" created: description: Will remain undocumented. Remove in v3 API. type: string createdAt: description: UNIX timestamp (in milliseconds) when the Team was created. examples: - 1630748523395 type: number id: description: The Team's unique identifier. examples: - team_nllPyCtREAqxxdyFKbbMDlxd type: string limited: description: Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges. type: boolean membership: oneOf: - description: The membership of the authenticated User in relation to the Team. properties: accessRequestedAt: type: number confirmed: type: boolean confirmedAt: type: number created: type: number createdAt: type: number joinedFrom: properties: commitId: type: string dsyncConnectedAt: type: number dsyncUserId: type: string gitUserId: oneOf: - type: string - type: number gitUserLogin: type: string idpUserId: type: string origin: enum: - import - saml - mail - link - teams - github - gitlab - bitbucket - dsync - feedback - organization-teams type: string repoId: type: string repoPath: type: string ssoConnectedAt: type: number ssoUserId: type: string required: - origin type: object role: enum: - MEMBER - OWNER - VIEWER - DEVELOPER - BILLING type: string teamId: type: string uid: type: string required: - confirmed - confirmedAt - role - uid - createdAt - created type: object - description: The membership of the authenticated User in relation to the Team. properties: accessRequestedAt: type: number confirmed: type: boolean confirmedAt: type: number created: type: number createdAt: type: number joinedFrom: properties: commitId: type: string dsyncConnectedAt: type: number dsyncUserId: type: string gitUserId: oneOf: - type: string - type: number gitUserLogin: type: string idpUserId: type: string origin: enum: - import - saml - mail - link - teams - github - gitlab - bitbucket - dsync - feedback - organization-teams type: string repoId: type: string repoPath: type: string ssoConnectedAt: type: number ssoUserId: type: string required: - origin type: object role: enum: - MEMBER - OWNER - VIEWER - DEVELOPER - BILLING type: string teamId: type: string uid: type: string required: - confirmed - accessRequestedAt - role - uid - createdAt - created type: object name: description: Name associated with the Team account, or `null` if none has been provided. examples: - My Team type: - string - "null" saml: description: When "Single Sign-On (SAML)" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced. properties: connection: description: From T, pick a set of properties whose keys are in the union K properties: createdAt: type: - number - "null" creator: type: string domain: type: string id: type: string name: type: string recordType: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string ttl: type: number type: enum: - record - record-sys type: string value: type: string required: - creator - domain - id - name - recordType - type - value type: object directory: description: From T, pick a set of properties whose keys are in the union K properties: createdAt: type: - number - "null" creator: type: string domain: type: string id: type: string name: type: string recordType: enum: - A - AAAA - ALIAS - CAA - CNAME - MX - SRV - TXT - NS type: string ttl: type: number type: enum: - record - record-sys type: string value: type: string required: - creator - domain - id - name - recordType - type - value type: object enforced: description: When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider. type: boolean required: - enforced type: object slug: description: The Team's slug, which is unique across the Vercel platform. examples: - my-team type: string required: - limited - id - slug - name - avatar - membership - created - createdAt type: object UserEvent: description: Array of events generated by the User. properties: createdAt: description: Timestamp (in milliseconds) of when the event was generated. examples: - 1632859321020 type: number entities: description: A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links. items: description: A list of "entities" within the event `text`. Useful for enhancing the displayed text with additional styling and links. properties: end: description: The index of where the entity ends within the `text` (non-inclusive). examples: - 3 type: number start: description: The index of where the entity begins within the `text` (inclusive). examples: - 0 type: number type: description: The type of entity. enum: - target - author - bitbucket_login - bold - deployment_host - dns_record - git_link - github_login - gitlab_login - hook_name - integration - edge-config - link - project_name - scaling_rules - env_var_name - system examples: - author type: string required: - type - start - end type: object type: array id: description: The unique identifier of the Event. examples: - uev_bfmMjiMnXfnPbT97dGdpJbCN type: string text: description: The human-readable text of the Event. examples: - You logged in via GitHub type: string user: description: Metadata for the User who generated the event. properties: avatar: type: string email: type: string slug: type: string uid: type: string username: type: string required: - avatar - email - uid - username type: object userId: description: The unique identifier of the User who generated the event. examples: - zTuNVUXEAvvnNN3IaqinkyMw type: string required: - id - text - entities - createdAt - userId type: object securitySchemes: bearerToken: description: Default authentication mechanism scheme: bearer type: http oauth2: flows: authorizationCode: authorizationUrl: https://api.vercel.com/oauth/authorize scopes: {} tokenUrl: https://api.vercel.com/oauth/access_token type: oauth2