environment

Lists all Shared Environment Variables for a team

Changed on

Lists all Shared Environment Variables for a team, taking into account optional filters.

get/v1/env

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/env
  • Auth: HTTP bearer

Query parameters

searchstring
projectIdstring

Filter SharedEnvVariables that belong to a project

Example:prj_2WjyKQmM8ZnGcJsPWMrHRHrE
idsstring

Filter SharedEnvVariables based on comma separated ids

Example:env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV
exclude_idsstring

Filter SharedEnvVariables based on comma separated ids

Example:env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV
exclude-idsstring

Filter SharedEnvVariables based on comma separated ids

Example:env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV
exclude_projectIdstring

Filter SharedEnvVariables that belong to a project

Example:prj_2WjyKQmM8ZnGcJsPWMrHRHrE
exclude-projectIdstring

Filter SharedEnvVariables that belong to a project

Example:prj_2WjyKQmM8ZnGcJsPWMrHRHrE
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

{
  "data": [
    {
      "created": "2021-02-10T13:11:49.180Z",
      "createdAt": 1609492210000,
      "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "deletedAt": 1609492210000,
      "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
      "key": "my-api-key",
      "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
      "projectId": [
        "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
        "prj_2WjyKQmM8ZnGcJsPWMrasEFg"
      ],
      "target": [
        "production"
      ],
      "type": "encrypted",
      "updatedAt": 1609492210000,
      "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A"
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Changes

  • dd6a90982ed0Revision changes
    • info

      added the optional property // to the response with the status

  • 83dbc1a3d2a1Revision changes
    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property // to the response with the status