Can I use CockroachDB as a CLI?

Yes. KosmoKrator exposes a CockroachDB CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose CockroachDB through MCP?

Yes. The KosmoKrator MCP gateway can expose selected CockroachDB tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are CockroachDB credentials stored?

CockroachDB credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for CockroachDB MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

CockroachDB CLI for AI Agents

Use the CockroachDB CLI from KosmoKrator to call CockroachDB tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

CockroachDB CLI Setup

CockroachDB can be configured headlessly with `kosmokrator integrations:configure cockroachdb`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure cockroachdb --enable --read allow --write ask --json
kosmokrator integrations:doctor cockroachdb --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

No credentials are required.

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call cockroachdb.cockroachdb_get_groups '{}' --json

Provider shortcut

kosmo integrations:cockroachdb cockroachdb_get_groups '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs cockroachdb --json
kosmo integrations:docs cockroachdb.cockroachdb_get_groups --json
kosmo integrations:schema cockroachdb.cockroachdb_get_groups --json
kosmo integrations:search "CockroachDB" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`cockroachdb.cockroachdb_get_groups`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_groups '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_groups '{}' --json

`cockroachdb.cockroachdb_create_group`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_group '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_group '{}' --json

`cockroachdb.cockroachdb_search_groups`

Similar to GetGroups however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details. Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_search_groups '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_search_groups '{}' --json

`cockroachdb.cockroachdb_get_groups2`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_groups2 '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_groups2 '{}' --json

`cockroachdb.cockroachdb_get_group`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_group '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_group '{}' --json

`cockroachdb.cockroachdb_update_group`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_group '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_group '{}' --json

`cockroachdb.cockroachdb_patch_group`

Apply a sequence of operations to modify attributes of a SCIM Group resource. Supports 'add', 'remove', and 'replace' operations per RFC 7644 Section 3.5.2. Operations are applied atomically - if any operation fails, no changes are applied. The request body must include the 'schemas' field set to 'urn:ietf:params:scim:api:messages:2.0:PatchOp'. Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_patch_group '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_patch_group '{}' --json

`cockroachdb.cockroachdb_delete_group`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_group '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_group '{}' --json

`cockroachdb.cockroachdb_search_group`

Similar to GetGroup however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details. Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_search_group '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_search_group '{}' --json

`cockroachdb.cockroachdb_get_group2`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_group2 '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_group2 '{}' --json

`cockroachdb.cockroachdb_get_resource_types`

This endpoint may be used by any member of the organization.

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_resource_types '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_resource_types '{}' --json

`cockroachdb.cockroachdb_get_resource_type`

This endpoint may be used by any member of the organization.

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_resource_type '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_resource_type '{}' --json

`cockroachdb.cockroachdb_get_schemas`

This endpoint may be used by any member of the organization.

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_schemas '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_schemas '{}' --json

`cockroachdb.cockroachdb_get_schema`

This endpoint may be used by any member of the organization.

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_schema '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_schema '{}' --json

`cockroachdb.cockroachdb_get_service_provider_config`

This endpoint may be used by any member of the organization.

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_service_provider_config '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_service_provider_config '{}' --json

`cockroachdb.cockroachdb_get_users`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_users '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_users '{}' --json

`cockroachdb.cockroachdb_create_user`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_user '{}' --json

`cockroachdb.cockroachdb_search_users`

Similar to GetUsers however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details. Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_search_users '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_search_users '{}' --json

`cockroachdb.cockroachdb_get_users2`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_users2 '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_users2 '{}' --json

`cockroachdb.cockroachdb_get_user`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_user '{}' --json

`cockroachdb.cockroachdb_update_user`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_user '{}' --json

`cockroachdb.cockroachdb_patch_user`

Apply a sequence of operations to modify attributes of a SCIM User resource. Supports 'add', 'remove', and 'replace' operations per RFC 7644 Section 3.5.2. Operations are applied atomically - if any operation fails, no changes are applied. The request body must include the 'schemas' field set to 'urn:ietf:params:scim:api:messages:2.0:PatchOp'. Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_patch_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_patch_user '{}' --json

`cockroachdb.cockroachdb_delete_user`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_user '{}' --json

`cockroachdb.cockroachdb_search_user`

Similar to GetUser however search parameters are passed via the POST body. See https://www.rfc-editor.org/rfc/rfc7644.html#section-3.4.3 for more details. Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_search_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_search_user '{}' --json

`cockroachdb.cockroachdb_get_user2`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_user2 '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_user2 '{}' --json

`cockroachdb.cockroachdb_list_api_keys`

Sort order: created_at Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_api_keys '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_api_keys '{}' --json

`cockroachdb.cockroachdb_create_api_key`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_api_key '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_api_key '{}' --json

`cockroachdb.cockroachdb_get_api_key`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_api_key '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_api_key '{}' --json

`cockroachdb.cockroachdb_update_api_key`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_api_key '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_api_key '{}' --json

`cockroachdb.cockroachdb_delete_api_key`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_api_key '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_api_key '{}' --json

`cockroachdb.cockroachdb_list_audit_logs`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_audit_logs '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_audit_logs '{}' --json

`cockroachdb.cockroachdb_list_major_cluster_versions`

Sort order: Version number descending This endpoint may be used by any member of the organization.

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_major_cluster_versions '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_major_cluster_versions '{}' --json

`cockroachdb.cockroachdb_list_clusters`

By default, clusters are sorted alphabetically by name in ascending A to Z order. To customize sorting, use the pagination.sort_by and pagination.sort_order query parameters. Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER - FOLDER_ADMIN - FOLDER_MOVER - METRICS_VIEWER - CLUSTER_MONITOR

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_clusters '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_clusters '{}' --json

`cockroachdb.cockroachdb_create_cluster`

Can be used by the following roles assigned at the organization or folder scope: - CLUSTER_ADMIN - CLUSTER_CREATOR

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_cluster '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_cluster '{}' --json

`cockroachdb.cockroachdb_list_available_regions`

Sort order: Distance (based on client IP address) This endpoint may be used by any member of the organization.

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_available_regions '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_available_regions '{}' --json

`cockroachdb.cockroachdb_get_cluster`

Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER - FOLDER_ADMIN - FOLDER_MOVER - METRICS_VIEWER - CLUSTER_MONITOR

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_cluster '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_cluster '{}' --json

`cockroachdb.cockroachdb_update_cluster`

In addition to adding nodes and changing cluster fields, the PATCH Cluster endpoint can be used to upgrade the cluster version. A cluster can be upgraded when its `upgrade_status` field is equal to `UPGRADE_AVAILABLE`. The `/api/v1/cluster-versions` endpoint can be used to enumerate versions which are valid to upgrade to. To begin the upgrade, PATCH the desired version into `cockroach_version`. For example `{"cockroach_version": "v24.2"}`. Multi-node clusters will undergo a rolling upgrade and will remain available, but single-node clusters will be briefly unavailable while the upgrade takes place. Upgrades will be finalized automatically after 72 hours but can be manually finalized by sending a PATCH containing `{"upgrade_status": "FINALIZED"}` to this endpoint. Before the cluster is finalized, it can be rolled back by either sending a PATCH of the previous version via `cockroach_version` or sending a PATCH containing `{"upgrade_status": "ROLLBACK_RUNNING"}`. Version upgrade operations cannot be performed simultaneously with other update operations. Only one of `upgrade_status` or `cockroach_version` is allowed in the request. Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_cluster '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_cluster '{}' --json

`cockroachdb.cockroachdb_delete_cluster`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_cluster '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_cluster '{}' --json

`cockroachdb.cockroachdb_list_backups`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_backups '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_backups '{}' --json

`cockroachdb.cockroachdb_get_backup_configuration`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_backup_configuration '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_backup_configuration '{}' --json

`cockroachdb.cockroachdb_update_backup_configuration`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_backup_configuration '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_backup_configuration '{}' --json

`cockroachdb.cockroachdb_list_blackout_windows`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_blackout_windows '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_blackout_windows '{}' --json

`cockroachdb.cockroachdb_create_blackout_window`

Blackout windows are supported for ADVANCED clusters only. Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_blackout_window '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_blackout_window '{}' --json

`cockroachdb.cockroachdb_get_blackout_window`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_blackout_window '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_blackout_window '{}' --json

`cockroachdb.cockroachdb_update_blackout_window`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_blackout_window '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_blackout_window '{}' --json

`cockroachdb.cockroachdb_delete_blackout_window`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_blackout_window '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_blackout_window '{}' --json

`cockroachdb.cockroachdb_get_client_c_a_cert`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_client_c_a_cert '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_client_c_a_cert '{}' --json

`cockroachdb.cockroachdb_set_client_c_a_cert`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_set_client_c_a_cert '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_set_client_c_a_cert '{}' --json

`cockroachdb.cockroachdb_update_client_c_a_cert`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_client_c_a_cert '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_client_c_a_cert '{}' --json

`cockroachdb.cockroachdb_delete_client_c_a_cert`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_client_c_a_cert '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_client_c_a_cert '{}' --json

`cockroachdb.cockroachdb_get_c_m_e_k_cluster_info`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_c_m_e_k_cluster_info '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_c_m_e_k_cluster_info '{}' --json

`cockroachdb.cockroachdb_enable_c_m_e_k_spec`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_enable_c_m_e_k_spec '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_enable_c_m_e_k_spec '{}' --json

`cockroachdb.cockroachdb_update_c_m_e_k_spec`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_c_m_e_k_spec '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_c_m_e_k_spec '{}' --json

`cockroachdb.cockroachdb_update_c_m_e_k_status`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_c_m_e_k_status '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_c_m_e_k_status '{}' --json

`cockroachdb.cockroachdb_get_connection_string`

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_connection_string '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_connection_string '{}' --json

`cockroachdb.cockroachdb_list_databases`

Sort order: Database name ascending Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_databases '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_databases '{}' --json

`cockroachdb.cockroachdb_create_database`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_database '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_database '{}' --json

`cockroachdb.cockroachdb_edit_database2`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_edit_database2 '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_edit_database2 '{}' --json

`cockroachdb.cockroachdb_edit_database`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_edit_database '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_edit_database '{}' --json

`cockroachdb.cockroachdb_delete_database`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_database '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_database '{}' --json

`cockroachdb.cockroachdb_get_cluster_disruption_info`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_cluster_disruption_info '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_cluster_disruption_info '{}' --json

`cockroachdb.cockroachdb_update_cluster_disruption`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_cluster_disruption '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_cluster_disruption '{}' --json

`cockroachdb.cockroachdb_get_log_export_info`

Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - METRICS_VIEWER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_log_export_info '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_log_export_info '{}' --json

`cockroachdb.cockroachdb_enable_log_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_enable_log_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_enable_log_export '{}' --json

`cockroachdb.cockroachdb_delete_log_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_log_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_log_export '{}' --json

`cockroachdb.cockroachdb_get_maintenance_window`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_maintenance_window '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_maintenance_window '{}' --json

`cockroachdb.cockroachdb_set_maintenance_window`

Maintenance windows are supported for ADVANCED clusters. Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_set_maintenance_window '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_set_maintenance_window '{}' --json

`cockroachdb.cockroachdb_delete_maintenance_window`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_maintenance_window '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_maintenance_window '{}' --json

`cockroachdb.cockroachdb_get_cloud_watch_metric_export_info`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - METRICS_VIEWER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_cloud_watch_metric_export_info '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_cloud_watch_metric_export_info '{}' --json

`cockroachdb.cockroachdb_enable_cloud_watch_metric_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_enable_cloud_watch_metric_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_enable_cloud_watch_metric_export '{}' --json

`cockroachdb.cockroachdb_delete_cloud_watch_metric_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_cloud_watch_metric_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_cloud_watch_metric_export '{}' --json

`cockroachdb.cockroachdb_get_datadog_metric_export_info`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - METRICS_VIEWER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_datadog_metric_export_info '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_datadog_metric_export_info '{}' --json

`cockroachdb.cockroachdb_enable_datadog_metric_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_enable_datadog_metric_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_enable_datadog_metric_export '{}' --json

`cockroachdb.cockroachdb_delete_datadog_metric_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_datadog_metric_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_datadog_metric_export '{}' --json

`cockroachdb.cockroachdb_get_prometheus_metric_export_info`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - METRICS_VIEWER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_prometheus_metric_export_info '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_prometheus_metric_export_info '{}' --json

`cockroachdb.cockroachdb_enable_prometheus_metric_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_enable_prometheus_metric_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_enable_prometheus_metric_export '{}' --json

`cockroachdb.cockroachdb_delete_prometheus_metric_export`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_prometheus_metric_export '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_prometheus_metric_export '{}' --json

`cockroachdb.cockroachdb_list_allowlist_entries`

Sort order: CIDR address Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_allowlist_entries '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_allowlist_entries '{}' --json

`cockroachdb.cockroachdb_add_allowlist_entry`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_add_allowlist_entry '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_add_allowlist_entry '{}' --json

`cockroachdb.cockroachdb_add_allowlist_entry2`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_add_allowlist_entry2 '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_add_allowlist_entry2 '{}' --json

`cockroachdb.cockroachdb_update_allowlist_entry`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_allowlist_entry '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_allowlist_entry '{}' --json

`cockroachdb.cockroachdb_delete_allowlist_entry`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_allowlist_entry '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_allowlist_entry '{}' --json

`cockroachdb.cockroachdb_list_aws_endpoint_connections`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_aws_endpoint_connections '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_aws_endpoint_connections '{}' --json

`cockroachdb.cockroachdb_set_aws_endpoint_connection_state`

The "status" in the response does not reflect the latest post-update status, but rather the status before the state is transitioned. Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_set_aws_endpoint_connection_state '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_set_aws_endpoint_connection_state '{}' --json

`cockroachdb.cockroachdb_list_egress_private_endpoints`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_egress_private_endpoints '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_egress_private_endpoints '{}' --json

`cockroachdb.cockroachdb_create_egress_private_endpoint`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_egress_private_endpoint '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_egress_private_endpoint '{}' --json

`cockroachdb.cockroachdb_get_egress_private_endpoint`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_egress_private_endpoint '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_egress_private_endpoint '{}' --json

`cockroachdb.cockroachdb_update_egress_private_endpoint`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_egress_private_endpoint '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_egress_private_endpoint '{}' --json

`cockroachdb.cockroachdb_delete_egress_private_endpoint`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_egress_private_endpoint '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_egress_private_endpoint '{}' --json

`cockroachdb.cockroachdb_update_egress_private_endpoint_domain_names`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_egress_private_endpoint_domain_names '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_egress_private_endpoint_domain_names '{}' --json

`cockroachdb.cockroachdb_list_egress_rules`

Sort order: Name Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_egress_rules '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_egress_rules '{}' --json

`cockroachdb.cockroachdb_add_egress_rule`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_add_egress_rule '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_add_egress_rule '{}' --json

`cockroachdb.cockroachdb_set_egress_traffic_policy`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_set_egress_traffic_policy '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_set_egress_traffic_policy '{}' --json

`cockroachdb.cockroachdb_get_egress_rule`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_egress_rule '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_egress_rule '{}' --json

`cockroachdb.cockroachdb_edit_egress_rule`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_edit_egress_rule '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_edit_egress_rule '{}' --json

`cockroachdb.cockroachdb_delete_egress_rule`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_egress_rule '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_egress_rule '{}' --json

`cockroachdb.cockroachdb_list_private_endpoint_connections`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_private_endpoint_connections '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_private_endpoint_connections '{}' --json

`cockroachdb.cockroachdb_add_private_endpoint_connection`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_add_private_endpoint_connection '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_add_private_endpoint_connection '{}' --json

`cockroachdb.cockroachdb_delete_private_endpoint_connection`

Remove a private endpoint from a service's trusted endpoints list. Caller should make sure to URL encode the endpoint_id before calling this method. Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_private_endpoint_connection '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_private_endpoint_connection '{}' --json

`cockroachdb.cockroachdb_list_private_endpoint_services`

The internal_dns property from the regions field in the ListClusters response can be used to connect to PrivateEndpointServices. Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_private_endpoint_services '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_private_endpoint_services '{}' --json

`cockroachdb.cockroachdb_create_private_endpoint_services`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_private_endpoint_services '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_private_endpoint_services '{}' --json

`cockroachdb.cockroachdb_list_private_endpoint_trusted_owners`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_private_endpoint_trusted_owners '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_private_endpoint_trusted_owners '{}' --json

`cockroachdb.cockroachdb_add_private_endpoint_trusted_owner`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_add_private_endpoint_trusted_owner '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_add_private_endpoint_trusted_owner '{}' --json

`cockroachdb.cockroachdb_get_private_endpoint_trusted_owner`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_private_endpoint_trusted_owner '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_private_endpoint_trusted_owner '{}' --json

`cockroachdb.cockroachdb_remove_private_endpoint_trusted_owner`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_remove_private_endpoint_trusted_owner '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_remove_private_endpoint_trusted_owner '{}' --json

`cockroachdb.cockroachdb_list_cluster_nodes`

Sort order: Region name, node name Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_cluster_nodes '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_cluster_nodes '{}' --json

`cockroachdb.cockroachdb_list_restores`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_restores '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_restores '{}' --json

`cockroachdb.cockroachdb_get_restore`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_restore '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_restore '{}' --json

`cockroachdb.cockroachdb_list_users`

Sort order: Username Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_users '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_users '{}' --json

`cockroachdb.cockroachdb_create_s_q_l_user`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_s_q_l_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_s_q_l_user '{}' --json

`cockroachdb.cockroachdb_delete_s_q_l_user`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_s_q_l_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_s_q_l_user '{}' --json

`cockroachdb.cockroachdb_update_s_q_l_user_password`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_s_q_l_user_password '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_s_q_l_user_password '{}' --json

`cockroachdb.cockroachdb_get_cluster_version_deferral`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_cluster_version_deferral '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_cluster_version_deferral '{}' --json

`cockroachdb.cockroachdb_set_cluster_version_deferral`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_set_cluster_version_deferral '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_set_cluster_version_deferral '{}' --json

`cockroachdb.cockroachdb_create_restore`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_restore '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_restore '{}' --json

`cockroachdb.cockroachdb_list_folders`

Sort order: Folder name Can be used by the following roles assigned at the organization or folder scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER - CLUSTER_CREATOR - FOLDER_ADMIN - FOLDER_MOVER - METRICS_VIEWER - CLUSTER_MONITOR

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_folders '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_folders '{}' --json

`cockroachdb.cockroachdb_create_folder`

Can be used by the following roles assigned at the organization or folder scope: - FOLDER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_folder '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_folder '{}' --json

`cockroachdb.cockroachdb_get_folder`

Can be used by the following roles assigned at the organization or folder scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER - CLUSTER_CREATOR - FOLDER_ADMIN - FOLDER_MOVER - METRICS_VIEWER - CLUSTER_MONITOR

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_folder '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_folder '{}' --json

`cockroachdb.cockroachdb_update_folder`

Can be used by the following roles assigned at the organization or folder scope: - FOLDER_ADMIN - FOLDER_MOVER

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_folder '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_folder '{}' --json

`cockroachdb.cockroachdb_delete_folder`

Can be used by the following roles assigned at the organization or folder scope: - FOLDER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_folder '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_folder '{}' --json

`cockroachdb.cockroachdb_list_folder_contents`

Set `folder_id` to 'root' to list root level contents. Sort order: Folders sorted by name, followed by Clusters sorted by name. Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER - FOLDER_ADMIN - FOLDER_MOVER - METRICS_VIEWER - CLUSTER_MONITOR

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_folder_contents '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_folder_contents '{}' --json

`cockroachdb.cockroachdb_list_invoices`

Sort order: invoice start date ascending Can be used by the following roles assigned at the organization scope: - BILLING_COORDINATOR - CLUSTER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_invoices '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_invoices '{}' --json

`cockroachdb.cockroachdb_get_invoice`

Can be used by the following roles assigned at the organization scope: - BILLING_COORDINATOR - CLUSTER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_invoice '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_invoice '{}' --json

`cockroachdb.cockroachdb_list_j_w_t_issuers`

Lists all the JWT Issuer configurations registered for the CockroachDB Cloud organization Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_j_w_t_issuers '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_j_w_t_issuers '{}' --json

`cockroachdb.cockroachdb_add_j_w_t_issuer`

Registers a JWT Issuer with the CockroachDB Cloud to allow verifying JWTs during API authentication Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_add_j_w_t_issuer '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_add_j_w_t_issuer '{}' --json

`cockroachdb.cockroachdb_get_j_w_t_issuer`

Retrieves the JWT Issuer configuration Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_j_w_t_issuer '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_j_w_t_issuer '{}' --json

`cockroachdb.cockroachdb_update_j_w_t_issuer`

Updates the JWT Issuer configuration Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_j_w_t_issuer '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_j_w_t_issuer '{}' --json

`cockroachdb.cockroachdb_delete_j_w_t_issuer`

Deletes the JWT Issuer configuration Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_j_w_t_issuer '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_j_w_t_issuer '{}' --json

`cockroachdb.cockroachdb_get_organization_info`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - ORG_MEMBER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_organization_info '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_organization_info '{}' --json

`cockroachdb.cockroachdb_list_physical_replication_streams`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_physical_replication_streams '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_physical_replication_streams '{}' --json

`cockroachdb.cockroachdb_create_physical_replication_stream`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_physical_replication_stream '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_physical_replication_stream '{}' --json

`cockroachdb.cockroachdb_get_physical_replication_stream`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - CLUSTER_DEVELOPER

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_physical_replication_stream '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_physical_replication_stream '{}' --json

`cockroachdb.cockroachdb_update_physical_replication_stream`

Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_physical_replication_stream '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_physical_replication_stream '{}' --json

`cockroachdb.cockroachdb_list_role_grants`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - FOLDER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_role_grants '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_role_grants '{}' --json

`cockroachdb.cockroachdb_get_all_roles_for_user`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - FOLDER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_all_roles_for_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_all_roles_for_user '{}' --json

`cockroachdb.cockroachdb_set_roles_for_user`

Replace the entire role set for a user or service account by providing its user_id or service_account_id. Roles that will be removed or added as a result of this call must follow the CC rules for role assignment: https://www.cockroachlabs.com/docs/cockroachcloud/authorization#organization-user-roles

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_set_roles_for_user '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_set_roles_for_user '{}' --json

`cockroachdb.cockroachdb_add_user_to_role`

Add a single role to a user or service account by providing its user_id or service_account_id. Roles that will be added as a result of this call must follow the CC rules for role assignment: https://www.cockroachlabs.com/docs/cockroachcloud/authorization#organization-user-roles

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_add_user_to_role '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_add_user_to_role '{}' --json

`cockroachdb.cockroachdb_remove_user_from_role`

Remove a single role from a user or service account by providing its user_id or service_account_id. Roles that will be removed as a result of this call must follow the CC rules for role assignment: https://www.cockroachlabs.com/docs/cockroachcloud/authorization#organization-user-roles

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_remove_user_from_role '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_remove_user_from_role '{}' --json

`cockroachdb.cockroachdb_list_service_accounts`

Sort order: Service account name Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_list_service_accounts '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_list_service_accounts '{}' --json

`cockroachdb.cockroachdb_create_service_account`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_create_service_account '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_create_service_account '{}' --json

`cockroachdb.cockroachdb_get_service_account`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_service_account '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_service_account '{}' --json

`cockroachdb.cockroachdb_update_service_account`

To manage roles associated with a service account after creation, pass the service_account_id instead of a user_id to any [Role Management endpoint](#tag--Role-Management). Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_update_service_account '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_update_service_account '{}' --json

`cockroachdb.cockroachdb_delete_service_account`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN

Write write

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_delete_service_account '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_delete_service_account '{}' --json

`cockroachdb.cockroachdb_get_person_users_by_email`

Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - FOLDER_ADMIN

Read read

Parameters: none

Generic call

kosmo integrations:call cockroachdb.cockroachdb_get_person_users_by_email '{}' --json

Shortcut

kosmo integrations:cockroachdb cockroachdb_get_person_users_by_email '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

cockroachdb.cockroachdb_get_groups 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_groups --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_group 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_group --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_search_groups 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_search_groups --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_groups2 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_groups2 --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_group 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_group --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_group 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_group --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_patch_group 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_patch_group --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_group 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_group --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_search_group 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_search_group --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_group2 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_group2 --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_resource_types 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_resource_types --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_resource_type 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_resource_type --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_schemas 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_schemas --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_schema 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_schema --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_service_provider_config 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_service_provider_config --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_users 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_users --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_search_users 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_search_users --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_users2 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_users2 --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_patch_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_patch_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_search_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_search_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_user2 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_user2 --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_api_keys 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_api_keys --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_api_key 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_api_key --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_api_key 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_api_key --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_api_key 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_api_key --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_api_key 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_api_key --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_audit_logs 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_audit_logs --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_major_cluster_versions 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_major_cluster_versions --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_clusters 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_clusters --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_cluster 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_cluster --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_available_regions 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_available_regions --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_cluster 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_cluster --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_cluster 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_cluster --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_cluster 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_cluster --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_backups 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_backups --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_backup_configuration 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_backup_configuration --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_backup_configuration 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_backup_configuration --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_blackout_windows 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_blackout_windows --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_blackout_window 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_blackout_window --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_blackout_window 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_blackout_window --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_blackout_window 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_blackout_window --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_blackout_window 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_blackout_window --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_client_c_a_cert 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_client_c_a_cert --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_set_client_c_a_cert 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_set_client_c_a_cert --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_client_c_a_cert 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_client_c_a_cert --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_client_c_a_cert 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_client_c_a_cert --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_c_m_e_k_cluster_info 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_c_m_e_k_cluster_info --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_enable_c_m_e_k_spec 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_enable_c_m_e_k_spec --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_c_m_e_k_spec 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_c_m_e_k_spec --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_c_m_e_k_status 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_c_m_e_k_status --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_connection_string 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_connection_string --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_databases 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_databases --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_database 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_database --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_edit_database2 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_edit_database2 --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_edit_database 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_edit_database --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_database 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_database --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_cluster_disruption_info 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_cluster_disruption_info --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_cluster_disruption 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_cluster_disruption --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_log_export_info 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_log_export_info --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_enable_log_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_enable_log_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_log_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_log_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_maintenance_window 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_maintenance_window --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_set_maintenance_window 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_set_maintenance_window --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_maintenance_window 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_maintenance_window --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_cloud_watch_metric_export_info 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_cloud_watch_metric_export_info --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_enable_cloud_watch_metric_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_enable_cloud_watch_metric_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_cloud_watch_metric_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_cloud_watch_metric_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_datadog_metric_export_info 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_datadog_metric_export_info --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_enable_datadog_metric_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_enable_datadog_metric_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_datadog_metric_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_datadog_metric_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_prometheus_metric_export_info 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_prometheus_metric_export_info --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_enable_prometheus_metric_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_enable_prometheus_metric_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_prometheus_metric_export 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_prometheus_metric_export --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_allowlist_entries 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_allowlist_entries --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_add_allowlist_entry 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_add_allowlist_entry --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_add_allowlist_entry2 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_add_allowlist_entry2 --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_allowlist_entry 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_allowlist_entry --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_allowlist_entry 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_allowlist_entry --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_aws_endpoint_connections 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_aws_endpoint_connections --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_set_aws_endpoint_connection_state 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_set_aws_endpoint_connection_state --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_egress_private_endpoints 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_egress_private_endpoints --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_egress_private_endpoint 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_egress_private_endpoint --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_egress_private_endpoint 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_egress_private_endpoint --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_egress_private_endpoint 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_egress_private_endpoint --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_egress_private_endpoint 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_egress_private_endpoint --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_egress_private_endpoint_domain_names 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_egress_private_endpoint_domain_names --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_egress_rules 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_egress_rules --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_add_egress_rule 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_add_egress_rule --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_set_egress_traffic_policy 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_set_egress_traffic_policy --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_egress_rule 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_egress_rule --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_edit_egress_rule 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_edit_egress_rule --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_egress_rule 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_egress_rule --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_private_endpoint_connections 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_private_endpoint_connections --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_add_private_endpoint_connection 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_add_private_endpoint_connection --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_private_endpoint_connection 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_private_endpoint_connection --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_private_endpoint_services 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_private_endpoint_services --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_private_endpoint_services 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_private_endpoint_services --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_private_endpoint_trusted_owners 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_private_endpoint_trusted_owners --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_add_private_endpoint_trusted_owner 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_add_private_endpoint_trusted_owner --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_private_endpoint_trusted_owner 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_private_endpoint_trusted_owner --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_remove_private_endpoint_trusted_owner 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_remove_private_endpoint_trusted_owner --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_cluster_nodes 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_cluster_nodes --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_restores 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_restores --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_restore 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_restore --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_users 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_users --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_s_q_l_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_s_q_l_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_s_q_l_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_s_q_l_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_s_q_l_user_password 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_s_q_l_user_password --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_cluster_version_deferral 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_cluster_version_deferral --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_set_cluster_version_deferral 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_set_cluster_version_deferral --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_restore 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_restore --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_folders 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_folders --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_folder 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_folder --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_folder 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_folder --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_folder 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_folder --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_folder 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_folder --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_folder_contents 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_folder_contents --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_invoices 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_invoices --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_invoice 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_invoice --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_j_w_t_issuers 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_j_w_t_issuers --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_add_j_w_t_issuer 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_add_j_w_t_issuer --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_j_w_t_issuer 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_j_w_t_issuer --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_j_w_t_issuer 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_j_w_t_issuer --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_j_w_t_issuer 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_j_w_t_issuer --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_organization_info 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_organization_info --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_physical_replication_streams 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_physical_replication_streams --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_physical_replication_stream 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_physical_replication_stream --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_physical_replication_stream 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_physical_replication_stream --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_physical_replication_stream 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_physical_replication_stream --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_role_grants 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_role_grants --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_all_roles_for_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_all_roles_for_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_set_roles_for_user 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_set_roles_for_user --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_add_user_to_role 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_add_user_to_role --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_remove_user_from_role 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_remove_user_from_role --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_list_service_accounts 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_list_service_accounts --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_create_service_account 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_create_service_account --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_service_account 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_service_account --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_update_service_account 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_update_service_account --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_delete_service_account 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_delete_service_account --json

Parameter	Type	Required	Description
No parameters.

cockroachdb.cockroachdb_get_person_users_by_email 0 parameters

Schema command

kosmo integrations:schema cockroachdb.cockroachdb_get_person_users_by_email --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.