config
Creates, updates, deletes, gets or lists a config resource.
Overview
| Name | config |
| Type | Resource |
| Id | vercel.rolling_release.config |
Fields
The following fields are returned by SELECT queries:
- get
Project-level rolling release configuration that defines how deployments should be gradually rolled out
| Name | Datatype | Description |
|---|---|---|
canary_response_header | boolean | Whether the request served by a canary deployment should return a header indicating a canary was served. Defaults to false when omitted. (false, true) (wire: canaryResponseHeader) |
gate | object | Automated gating configuration. Omitted (the default) means no gating is configured, which is equivalent to enabled: false. |
stages | array | An array of all the stages required during a deployment release. Each stage defines a target percentage and advancement rules. The final stage must always have targetPercentage: 100. |
target | string | The environment that the release targets, currently only supports production. Adding in case we want to configure with alias groups or custom environments. (example: production) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id_or_name | team_id, slug | Get the Rolling Releases configuration for a project. The project-level config is simply a template that will be used for any future rolling release, and not the configuration for any active rolling release. |
update | update | id_or_name | team_id, slug | Update (or disable) Rolling Releases for a project. When disabling with the resolve-on-disable feature flag enabled, any active rolling release document is resolved using the disableRolloutAction parameter: "abort" to roll back (default), or "complete" to promote the canary to production. When enabling or updating config, changes only affect the next production deployment and do not alter a rollout that's already in-flight. Note: Enabling Rolling Releases automatically enables skew protection on the project with the default value if it wasn't configured already. |
delete | delete | id_or_name | team_id, slug | Disable Rolling Releases for a project means that future deployments will not undergo a rolling release. Changing the config never alters a rollout that's already in-flight—it only affects the next production deployment. If you want to also stop the current rollout, call this endpoint to disable the feature, and then call either the /complete or /abort endpoint. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id_or_name | string | Project ID or project name (URL-encoded) |
slug | string | The Team slug to perform the request on behalf of. |
team_id | string | The Team identifier to perform the request on behalf of. (wire: teamId) |
SELECT examples
- get
Get the Rolling Releases configuration for a project. The project-level config is simply a template that will be used for any future rolling release, and not the configuration for any active rolling release.
SELECT
canary_response_header,
gate,
stages,
target
FROM vercel.rolling_release.config
WHERE id_or_name = '{{ id_or_name }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;
UPDATE examples
- update
Update (or disable) Rolling Releases for a project. When disabling with the resolve-on-disable feature flag enabled, any active rolling release document is resolved using the disableRolloutAction parameter: "abort" to roll back (default), or "complete" to promote the canary to production. When enabling or updating config, changes only affect the next production deployment and do not alter a rollout that's already in-flight. Note: Enabling Rolling Releases automatically enables skew protection on the project with the default value if it wasn't configured already.
UPDATE vercel.rolling_release.config
SET
-- No updatable properties
WHERE
id_or_name = '{{ id_or_name }}' --required
AND team_id = '{{ team_id}}'
AND slug = '{{ slug}}'
RETURNING
rolling_release;
DELETE examples
- delete
Disable Rolling Releases for a project means that future deployments will not undergo a rolling release. Changing the config never alters a rollout that's already in-flight—it only affects the next production deployment. If you want to also stop the current rollout, call this endpoint to disable the feature, and then call either the /complete or /abort endpoint.
DELETE FROM vercel.rolling_release.config
WHERE id_or_name = '{{ id_or_name }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;