> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Backup Get

> Get the details and status of one ClickHouse Cloud service backup by its ID. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Get the details and status of one ClickHouse Cloud service backup by its ID.

> [!NOTE]
>
> Tool ID: `clickhouse_backup_get`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_backup_get',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "backupId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_backup_get --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "backupId": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "id": "123e4567-e89b-42d3-a456-426614174000",
      "status": "done",
      "serviceId": "service_123"
    }
  }
}
```

Use `deepline describe clickhouse_backup_get --json` for the latest machine-readable contract.

## Input reference

Returns a single backup info.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the organization that owns the backup. Format: `uuid`. |
| `payload.serviceId` | `string` | Yes | — | ID of the service the backup was created from. Format: `uuid`. |
| `payload.backupId` | `string` | Yes | — | ID of the requested backup. Format: `uuid`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a single backup info.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the backup.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the service the backup was created from.",
        "format": "uuid"
      },
      "backupId": {
        "type": "string",
        "description": "ID of the requested backup.",
        "format": "uuid"
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "backupId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.status` | `number` | No | — | HTTP status code. |
| `result.data.requestId` | `string` | No | — | Unique id assigned to every request. UUIDv4 Format: `uuid`. |
| `result.data.result` | `object` | No | — | — |
| `result.data.result.id` | `string` | No | — | Unique backup ID. Format: `uuid`. |
| `result.data.result.status` | `"done" \| "error" \| "in_progress"` | No | — | Status of the backup: 'done', 'error', 'in\_progress'. Allowed: `done`, `error`, `in_progress`. |
| `result.data.result.serviceId` | `string` | No | — | Name |
| `result.data.result.startedAt` | `string` | No | — | Backup start timestamp. ISO-8601. Format: `date-time`. |
| `result.data.result.finishedAt` | `string` | No | — | Backup finish timestamp. ISO-8601. Available only for finished backups Format: `date-time`. |
| `result.data.result.sizeInBytes` | `number` | No | — | Size of the backup in bytes. |
| `result.data.result.durationInSeconds` | `number` | No | — | Time in seconds it took to perform the backup. If the status still in\_progress, this is the time in seconds since the backup started until now. |
| `result.data.result.type` | `"full" \| "incremental"` | No | — | Backup type ("full" or "incremental"). Allowed: `full`, `incremental`. |
| `result.data.result.backupName` | `string` | No | — | Backup name on the external backup bucket. |
| `result.data.result.bucket` | `record` | No | — | Backup bucket where the backup is stored. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique backup ID.",
                "format": "uuid"
              },
              "status": {
                "type": "string",
                "description": "Status of the backup: 'done', 'error', 'in_progress'.",
                "enum": [
                  "done",
                  "error",
                  "in_progress"
                ]
              },
              "serviceId": {
                "type": "string",
                "description": "Name"
              },
              "startedAt": {
                "type": "string",
                "description": "Backup start timestamp. ISO-8601.",
                "format": "date-time"
              },
              "finishedAt": {
                "type": "string",
                "description": "Backup finish timestamp. ISO-8601. Available only for finished backups",
                "format": "date-time"
              },
              "sizeInBytes": {
                "type": "number",
                "description": "Size of the backup in bytes."
              },
              "durationInSeconds": {
                "type": "number",
                "description": "Time in seconds it took to perform the backup. If the status still in_progress, this is the time in seconds since the backup started until now."
              },
              "type": {
                "type": "string",
                "description": "Backup type (\"full\" or \"incremental\").",
                "enum": [
                  "full",
                  "incremental"
                ]
              },
              "backupName": {
                "type": "string",
                "description": "Backup name on the external backup bucket."
              },
              "bucket": {
                "type": "object",
                "description": "Backup bucket where the backup is stored.",
                "additionalProperties": true
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.