> ## 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 Instance Query Endpoint Upsert

> Upsert the service query endpoint for a given instance. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Upsert the service query endpoint for a given instance.

<Info>
  Tool ID: `clickhouse_instance_query_endpoint_upsert`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

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

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

### CLI

```bash theme={null}
deepline tools execute clickhouse_instance_query_endpoint_upsert --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "id": "id_123",
      "openApiKeys": [
        "example"
      ],
      "roles": [
        "sql_console_read_only"
      ]
    }
  }
}
```

Use `deepline tools get clickhouse_instance_query_endpoint_upsert --json` for the latest machine-readable contract.

## Input reference

Create the service query endpoint that allows executing queries via API.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the requested organization. Format: `uuid`. |
| `payload.serviceId` | `string` | Yes | — | ID of the requested service. Format: `uuid`. |
| `payload.roles` | `array` | No | — | The roles |
| `payload.openApiKeys` | `array` | No | — | The version of the service query endpoint |
| `payload.allowedOrigins` | `string` | No | — | The allowed origins as comma separated list of domains |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Create the service query endpoint that allows executing queries via API.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the requested organization.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the requested service.",
        "format": "uuid"
      },
      "roles": {
        "type": "array",
        "description": "The roles",
        "items": {
          "type": "string",
          "enum": [
            "sql_console_read_only",
            "sql_console_admin"
          ]
        }
      },
      "openApiKeys": {
        "type": "array",
        "description": "The version of the service query endpoint",
        "items": {
          "type": "string"
        }
      },
      "allowedOrigins": {
        "type": "string",
        "description": "The allowed origins as comma separated list of domains"
      }
    },
    "required": [
      "organizationId",
      "serviceId"
    ],
    "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 | — | The id of the service query endpoint |
| `result.data.result.openApiKeys` | `array` | No | — | List of OpenAPI keys that can access the service query endpoint |
| `result.data.result.roles` | `array` | No | — | List of roles that can access the service query endpoint |
| `result.data.result.allowedOrigins` | `string` | No | — | The allowed origins as comma separated list of domains |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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": "The id of the service query endpoint"
              },
              "openApiKeys": {
                "type": "array",
                "description": "List of OpenAPI keys that can access the service query endpoint",
                "items": {
                  "type": "string"
                }
              },
              "roles": {
                "type": "array",
                "description": "List of roles that can access the service query endpoint",
                "items": {
                  "type": "string",
                  "enum": [
                    "sql_console_read_only",
                    "sql_console_admin"
                  ]
                }
              },
              "allowedOrigins": {
                "type": "string",
                "description": "The allowed origins as comma separated list of domains"
              }
            },
            "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](/docs/providers/clickhouse/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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