Skip to main content
Planview Customer Success Center

API: Delete a log

POST /api/rest/v1/log/delete/{log_id}

Delete a log by its ID.

Security

Bearer Token Authentication (BearerAuth)

Headers

Key Value Description Required

Authorization

Bearer <token>

The bearer token for authentication and access.

Yes

Path Parameters

Name

In

Type

Required

Description

log_id

path

string

Yes

The ID of the log to be deleted.

Request Body

Content-Type: application/json

Schema Definitions

Field

Type

Required

Description

app_context

object

Yes

App context including container_id, tenant_group, etc.

 

AppContext

For the full structure, see API: Create single or multiple logs.

Request body example

{
  "app_context": [
    {
      "container_id": 0,
      "container_source": "string",
      "container_type": "string"
    }
  ]
}

Response

Status Code: 200 OK

Content-Type: application/json

Top-level key: rest_delete_log

Field

Type

Description

Example

deleted_id

string

ID of the deleted log

'123'

Response example

{
  "code": "LOG_DOES_NOT_EXIST",
  "message": "The log does not exist in the system"
}

Status Code: Unauthorized (401 Unauthorized)

Content-Type: application/json

Code

Message

INVALID_CONTAINER

The log does not exist in the provided container inapp_context

INVALID_TENANT

The log does not belong to the providedtenant_group

 Response example

{
  "code": "INVALID_CONTAINER",
  "message": "The log does not exist in the provided container in app_context"
}