purge_logs #
On this page
Generated automatically from the published contract sources.
A script calls this action over HTTPS at POST https://tzcloud.turnzero.ai/v1/purge_logs, with a bearer credential and the action's payload as the JSON body. An MCP connection lists this action as the tool tzcloud_purge_logs.
OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts (Sign-in, sessions, and tokens).
Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.
Contract description #
Erase every log entry and counter total for one application environment, or all environments if you pass none, before retention ends. It can clear log_capacity_reached. This cannot be undone. The control plane's own record stays. Container console output stays in the hosting provider's logs for up to thirty days, beyond any purge.
Destructive: needs a signed-in session or a token minted with destructive. Give approval_url to the account's owner for browser approval. Nothing is erased before it. Read read_approval_status to its end for the counts erased.
More about this action #
Pass request_id to make a repeat safe. While the earlier pending action is still live (requested, approved, or executing), a call with the same request_id from the same account returns that action and creates no second one. Once the action has completed, failed, been declined, or expired, the same request_id starts a new one.
Approval covers the selected streams, including entries added before the purge; it does not bind the counts at request time.
Access and action metadata #
{
"name": "purge_logs",
"resource": "application",
"tier": "destructive",
"surface": "tzcloud",
"addresses": [
"tzcloud"
],
"product": "cloud",
"summary": "Erase the application's log entries and counter totals ahead of retention: one environment's, or every environment's where none is given. It is your own purge under the approval flow, never undone, the control plane's record untouched.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"openWorldHint": false
}
}
MCP catalog entry #
{
"name": "purge_logs",
"title": "Purge logs",
"tier": "destructive",
"scenario": "CHI-L0-10",
"summary": "Erase every log entry and counter total for one application environment, or all environments if you pass none, before retention ends. It can clear `log_capacity_reached`. This cannot be undone. The control plane's own record stays. Container console output stays in the hosting provider's logs for up to thirty days, beyond any purge.\n\nDestructive: needs a signed-in session or a token minted with `destructive`. Give `approval_url` to the account's owner for browser approval. Nothing is erased before it. Read `read_approval_status` to its end for the counts erased.",
"owners": [
"LGS-L0-19",
"MAPI-05"
]
}
request #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | Type: object Required fields: ["application"] |
| / |
Your account's application id from list_applications, not its name or label.Type: string |
| / |
Erase development, production or local; omitted or empty erases all. Other strings draw invalid_request before any approval request.Type: string |
| / |
Any string you choose. A repeat from the same account while that pending action is live returns it again, creating no second one. Omitted, every call creates a new one. Type: string |
response #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | The 202 creation envelope: the pending action and its approval link. Read the terminal outcome on the pending record with read_approval_status. Type: object Required fields: ["contract_version","pending_action","approval_url"] |
| / |
Required value: 1 |
| / |
The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call. Type: string Pattern: ^[0-9a-f]{10}$ |
| / |
$ref: #/shapes/pending_action |
| / |
Type: string |
| / |
Type: string |
Complete payload contract #
{
"request": {
"type": "object",
"required": [
"application"
],
"properties": {
"application": {
"type": "string",
"description": "Your account's application `id` from `list_applications`, not its name or label."
},
"environment": {
"type": "string",
"description": "Erase `development`, `production` or `local`; omitted or empty erases all. Other strings draw `invalid_request` before any approval request."
},
"request_id": {
"type": "string",
"description": "Any string you choose. A repeat from the same account while that pending action is live returns it again, creating no second one. Omitted, every call creates a new one."
}
}
},
"response": {
"type": "object",
"description": "The 202 creation envelope: the pending action and its approval link. Read the terminal outcome on the pending record with read_approval_status (API-L0-07).",
"required": [
"contract_version",
"pending_action",
"approval_url"
],
"properties": {
"contract_version": {
"const": 1
},
"reference": {
"type": "string",
"pattern": "^[0-9a-f]{10}$",
"description": "The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call."
},
"pending_action": {
"$ref": "#/shapes/pending_action"
},
"approval_url": {
"type": "string"
},
"detail": {
"type": "string"
}
}
}
}
Shared contracts #
- Refusals: every refusal, by surface, with its cause and its remedy
- schemas/wire_error.schema.json
- schemas/wire_errors.json
- schemas/action_payloads.json (includes shared shapes)
- management_api_contract.md