Skip to Content

Clear Storage

POST/v0/pipelines/{pipeline_name}/clear
Authentication
Parameters

Clears the pipeline storage asynchronously.

IMPORTANT: Clearing means disassociating the storage from the pipeline. Depending on the storage type this can include its deletion.

It sets the storage state to Clearing, after which the clearing process is performed asynchronously. Progress should be monitored by polling the pipeline using the GET endpoints. An /clear cannot be cancelled.

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

NameTypeRequiredDescription
pipeline_namestringYesUnique pipeline name

Response

Action is accepted and is being performed
Request
curl -X POST '/v0/pipelines/{pipeline_name}/clear' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
Pipeline with that name does not exist
{ "message": "Unknown pipeline name 'non-existent-pipeline'", "error_code": "UnknownPipelineName", "details": { "pipeline_name": "non-existent-pipeline" } }