v14

latestOpenAPI 3.0.32026-08-04377889.4 MB

projects

Retrieve a list of projects

Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects.

get/v10/projects

Query parameters

fromstring

Query only projects updated after the given timestamp or continuation token.

gitForkProtection'1' | '0'

Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed

Example:1

Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed

limitstring

Limit the number of projects returned

searchstring

Search projects by the name field

repostring

Filter results by repo. Also used for project count

repoIdstring

Filter results by Repository ID.

repoUrlstring

Filter results by Repository URL.

Example:https://github.com/vercel/next.js

Filter results by Repository URL.

excludeReposstring

Filter results by excluding those projects that belong to a repo

edgeConfigIdstring

Filter results by connected Edge Config ID

edgeConfigTokenIdstring

Filter results by connected Edge Config Token ID

deprecatedboolean

elasticConcurrencyEnabled'1' | '0'

Filter results by projects with elastic concurrency enabled

Example:1

Filter results by projects with elastic concurrency enabled

staticIpsEnabled'0' | '1'

Filter results by projects with Static IPs enabled

Example:1

Filter results by projects with Static IPs enabled

buildMachineTypesstring

Filter results by build machine types. Accepts comma-separated values. Use "default" for projects without a build machine type set.

Example:default,enhanced

Filter results by build machine types. Accepts comma-separated values. Use "default" for projects without a build machine type set.

buildQueueConfiguration'SKIP_NAMESPACE_QUEUE' | 'WAIT_FOR_NAMESPACE_QUEUE'

Filter results by build queue configuration. SKIP_NAMESPACE_QUEUE includes projects without a configuration set.

Example:SKIP_NAMESPACE_QUEUE

Filter results by build queue configuration. SKIP_NAMESPACE_QUEUE includes projects without a configuration set.

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Example response

[
  {
    "rollingRelease": {
      "target": "production",
      "stages": [
        {
          "targetPercentage": 25,
          "duration": 600
        }
      ]
    }
  }
]