Delete task
- Print
- PDF
Delete task
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Delete a task model.
Use this when you want to delete a task that you no longer use or that is unnecessary. Deletion may not be possible depending on the current status and dependencies of the task.
Check deletion condition
| Task status | Task usage status (dependency check) | |
|---|---|---|
| Deletion available | registered registeredcompleted availablefailed failed | |
| Deletion unavailable | pending pendingin_progress creating | If the function that uses the task you want to delete (task model run or shopping intent) is running (pending or in_progress) |
If the deletion is not possible, you will receive an error message. After checking the error message, proceed under the conditions that allow deletion.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| DELETE | /api/v1/tasks/{task_id} |
Request headers
For information about the headers common to all NCLUE APIs, see Common NCLUE headers.
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
task_id | String | Required | Feature ID
|
Request example
The request example is as follows:
curl --location --request DELETE 'https://nclue.apigw.ntruss.com/api/v1/tasks/{task_id}' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'
Response
This section describes the response format.
Response example
The response example is as follows:
Succeeded
The following is a sample response upon a successful call.
{
"task_id": "b5e742f1-0558-465a-8485-3b7808b0e125"
}
Failure
For examples of responses in the event of a failed call, see Response status codes.
Was this article helpful?