Clear Storage
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
| Scheme | Type | Details |
|---|---|---|
JSON web token (JWT) or API key | Bearer token | Authorization 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
| Name | Type | Required | Description |
|---|---|---|---|
pipeline_name | string | Yes | Unique pipeline name |
Response
Action is accepted and is being performed
curl -X POST '/v0/pipelines/{pipeline_name}/clear' \
-H 'Authorization: Bearer YOUR_TOKEN'Pipeline with that name does not exist
{
"message": "Unknown pipeline name 'non-existent-pipeline'",
"error_code": "UnknownPipelineName",
"details": {
"pipeline_name": "non-existent-pipeline"
}
}