IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/project/pipelines/delete-preview-environment.md, instead of the current page.

Project / Pipelines /

Delete preview environment

Delete a preview environment generated by a preview template.

Required permission

Account > Templates > General > Delete

Path parameters

projectId
string required
ID of the project
pipelineId
string required
ID of the pipeline
previewId
string required
ID of the preview environment

Query parameters

skipTeardown
boolean
If `true`, the teardown spec will not be run when deleting the preview environment.

Request body

{object}

teardownArgumentOverrides
{object}
Argument overrides to pass to the teardown spec when deleting the preview environment.

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

DELETE /v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs/previews/{previewId}

DELETE /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/preview-envs/previews/{previewId}

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request DELETE \
  --data 'undefined' \
  https://api.northflank.com/v1/projects/{projectId}/pipelines/{pipelineId}/preview-envs/previews/{previewId}

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}