> ## 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 Openapi Key Get: Inputs, Cost & CLI Example

> Get key details. Clickhouse Clickhouse Openapi Key Get docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_openapi_key_get:{"organizationId":"{{organizationId}}","keyId":"{{keyId}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                     | Type     | Required | Default | Description                       |
| ------------------------ | -------- | -------- | ------- | --------------------------------- |
| `payload.organizationId` | `string` | Yes      |         | ID of the requested organization. |
| `payload.keyId`          | `string` | Yes      |         | ID of the requested key.          |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Returns a single key details.",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the requested organization.",
        "format": "uuid"
      },
      "keyId": {
        "type": "string",
        "description": "ID of the requested key.",
        "format": "uuid"
      }
    },
    "required": [
      "organizationId",
      "keyId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `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": "Unique API key ID.",
                "format": "uuid"
              },
              "name": {
                "type": "string",
                "description": "Name of the key"
              },
              "state": {
                "type": "string",
                "description": "State of the key: 'enabled', 'disabled'.",
                "enum": [
                  "enabled",
                  "disabled"
                ]
              },
              "roles": {
                "type": "array",
                "description": "DEPRECATED. Use `assignedRoles` instead. List of roles assigned to the key. For organizations that have migrated to custom roles, this field is frozen at the pre-migration value and does not reflect current role assignments.",
                "items": {
                  "type": "string",
                  "enum": [
                    "admin",
                    "developer",
                    "query_endpoints"
                  ]
                }
              },
              "assignedRoles": {
                "type": "array",
                "description": "Custom roles and System roles assigned to this API key",
                "items": {
                  "properties": {
                    "roleId": {
                      "type": "string",
                      "description": "Unique identifier of the role",
                      "format": "uuid"
                    },
                    "roleName": {
                      "type": "string",
                      "description": "Human-readable name of the role"
                    },
                    "roleType": {
                      "type": "string",
                      "description": "Type of role: system (predefined) or custom (organization-defined)",
                      "enum": [
                        "system",
                        "custom"
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              },
              "keySuffix": {
                "type": "string",
                "description": "Last 4 letters of the key."
              },
              "createdAt": {
                "type": "string",
                "description": "Timestamp the key was created. ISO-8601.",
                "format": "date-time"
              },
              "expireAt": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Timestamp the key expires. If not present, `null` or is empty the key never expires. ISO-8601.",
                "format": "date-time"
              },
              "usedAt": {
                "type": "string",
                "description": "Timestamp the key was used last time, with one-minute precision. If not present the key was never used. ISO-8601.",
                "format": "date-time"
              },
              "ipAccessList": {
                "type": "array",
                "description": "List of IP addresses allowed to access the API using this key",
                "items": {
                  "properties": {
                    "source": {
                      "type": "string",
                      "description": "IP or CIDR"
                    },
                    "description": {
                      "type": "string",
                      "description": "Optional description of IPv4 address or IPv4 CIDR to allow access from"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute clickhouse_openapi_key_get --payload '{
  "organizationId": "string",
  "keyId": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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