KosmoKrator

data

CockroachDB Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the CockroachDB KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.cockroachdb.*. Use lua_read_doc("integrations.cockroachdb") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic CockroachDB workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.cockroachdb.list_groups({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("cockroachdb"))' --json
kosmo integrations:lua --eval 'print(docs.read("cockroachdb.list_groups"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local cockroachdb = app.integrations.cockroachdb
local result = cockroachdb.list_groups({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.cockroachdb, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.cockroachdb.default.* or app.integrations.cockroachdb.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need CockroachDB, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

CockroachDB Cloud Lua API Reference

Namespace: cockroachdb

This integration exposes generated coverage for CockroachDB Cloud’s official OpenAPI document at https://cockroachlabs.cloud/assets/docs/api/latest/openapi.json.

Configure url as the API root, usually https://cockroachlabs.cloud. Existing configs that use https://cockroachlabs.cloud/api/v1 continue to work for Cloud v1 tools.

Authentication uses a CockroachDB Cloud API key as a bearer token. Endpoint access depends on the roles assigned to that API key.

Common Tools

  • cockroachdb_list_clusters maps to GET /api/v1/clusters.
  • cockroachdb_get_cluster maps to GET /api/v1/clusters/{cluster_id}.
  • cockroachdb_create_cluster maps to POST /api/v1/clusters.
  • cockroachdb_list_databases maps to GET /api/v1/clusters/{cluster_id}/databases.
  • cockroachdb_list_users maps to GET /api/v1/clusters/{cluster_id}/sql-users.

The generated catalog also covers API keys, audit logs, available regions, backups, backup config, blackout windows, client CA certificates, CMEK, connection strings, folders, invites, maintenance windows, metrics exports, networking, node maps, physical replication streams, private endpoints, roles, JWT issuers, spend limits, egress rules, log export, and SCIM users/groups/schemas.

Arguments

Path and query parameters use names from the OpenAPI document. Snake-case aliases are also accepted. For dotted query parameters such as pagination.limit, you may pass either pagination.limit or pagination_limit.

Tools with a JSON request body accept a body table. If body is omitted, non-path/query/header arguments are collected into the JSON body.

Examples

local clusters = cockroachdb.cockroachdb_list_clusters({
  pagination_limit = 25
})
local cluster = cockroachdb.cockroachdb_get_cluster({
  cluster_id = "00000000-0000-0000-0000-000000000000"
})
local databases = cockroachdb.cockroachdb_list_databases({
  cluster_id = "00000000-0000-0000-0000-000000000000",
  pagination_limit = 50
})
local created = cockroachdb.cockroachdb_create_cluster({
  body = {
    name = "agent-demo",
    provider = "AWS",
    spec = {}
  }
})

Return Shapes

Responses are CockroachDB Cloud’s parsed JSON responses. Paginated responses may include token or pagination fields, depending on the endpoint.

Non-JSON responses return:

{
  body = "...",
  content_type = "text/plain"
}

The previous cockroachdb_get_current_user and cockroachdb_get_database helpers are intentionally not part of the generated catalog because the current official OpenAPI document does not expose those operations.

Raw agent markdown 
# CockroachDB Cloud Lua API Reference

Namespace: `cockroachdb`

This integration exposes generated coverage for CockroachDB Cloud's official OpenAPI document at `https://cockroachlabs.cloud/assets/docs/api/latest/openapi.json`.

Configure `url` as the API root, usually `https://cockroachlabs.cloud`. Existing configs that use `https://cockroachlabs.cloud/api/v1` continue to work for Cloud v1 tools.

Authentication uses a CockroachDB Cloud API key as a bearer token. Endpoint access depends on the roles assigned to that API key.

## Common Tools

- `cockroachdb_list_clusters` maps to `GET /api/v1/clusters`.
- `cockroachdb_get_cluster` maps to `GET /api/v1/clusters/{cluster_id}`.
- `cockroachdb_create_cluster` maps to `POST /api/v1/clusters`.
- `cockroachdb_list_databases` maps to `GET /api/v1/clusters/{cluster_id}/databases`.
- `cockroachdb_list_users` maps to `GET /api/v1/clusters/{cluster_id}/sql-users`.

The generated catalog also covers API keys, audit logs, available regions, backups, backup config, blackout windows, client CA certificates, CMEK, connection strings, folders, invites, maintenance windows, metrics exports, networking, node maps, physical replication streams, private endpoints, roles, JWT issuers, spend limits, egress rules, log export, and SCIM users/groups/schemas.

## Arguments

Path and query parameters use names from the OpenAPI document. Snake-case aliases are also accepted. For dotted query parameters such as `pagination.limit`, you may pass either `pagination.limit` or `pagination_limit`.

Tools with a JSON request body accept a `body` table. If `body` is omitted, non-path/query/header arguments are collected into the JSON body.

## Examples

```lua
local clusters = cockroachdb.cockroachdb_list_clusters({
  pagination_limit = 25
})
```

```lua
local cluster = cockroachdb.cockroachdb_get_cluster({
  cluster_id = "00000000-0000-0000-0000-000000000000"
})
```

```lua
local databases = cockroachdb.cockroachdb_list_databases({
  cluster_id = "00000000-0000-0000-0000-000000000000",
  pagination_limit = 50
})
```

```lua
local created = cockroachdb.cockroachdb_create_cluster({
  body = {
    name = "agent-demo",
    provider = "AWS",
    spec = {}
  }
})
```

## Return Shapes

Responses are CockroachDB Cloud's parsed JSON responses. Paginated responses may include token or pagination fields, depending on the endpoint.

Non-JSON responses return:

```lua
{
  body = "...",
  content_type = "text/plain"
}
```

The previous `cockroachdb_get_current_user` and `cockroachdb_get_database` helpers are intentionally not part of the generated catalog because the current official OpenAPI document does not expose those operations.
Metadata-derived Lua example 
local result = app.integrations.cockroachdb.list_groups({})
print(result)

Functions

list_groups Read

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

Lua path
app.integrations.cockroachdb.list_groups
Full name
cockroachdb.cockroachdb_get_groups
ParameterTypeRequiredDescription
No parameters.
create_group Write

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

Lua path
app.integrations.cockroachdb.create_group
Full name
cockroachdb.cockroachdb_create_group
ParameterTypeRequiredDescription
No parameters.
search_groups Write

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

Lua path
app.integrations.cockroachdb.search_groups
Full name
cockroachdb.cockroachdb_search_groups
ParameterTypeRequiredDescription
No parameters.
search_groups_deprecated Write

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

Lua path
app.integrations.cockroachdb.search_groups_deprecated
Full name
cockroachdb.cockroachdb_get_groups2
ParameterTypeRequiredDescription
No parameters.
get_group_by_id Read

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

Lua path
app.integrations.cockroachdb.get_group_by_id
Full name
cockroachdb.cockroachdb_get_group
ParameterTypeRequiredDescription
No parameters.
update_group_by_supplying_all_values_user_object Write

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

Lua path
app.integrations.cockroachdb.update_group_by_supplying_all_values_user_object
Full name
cockroachdb.cockroachdb_update_group
ParameterTypeRequiredDescription
No parameters.
patch_group_by_supplying_partial_updates Write

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

Lua path
app.integrations.cockroachdb.patch_group_by_supplying_partial_updates
Full name
cockroachdb.cockroachdb_patch_group
ParameterTypeRequiredDescription
No parameters.
delete_group_based_id Write

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

Lua path
app.integrations.cockroachdb.delete_group_based_id
Full name
cockroachdb.cockroachdb_delete_group
ParameterTypeRequiredDescription
No parameters.
search_group_by_id Write

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

Lua path
app.integrations.cockroachdb.search_group_by_id
Full name
cockroachdb.cockroachdb_search_group
ParameterTypeRequiredDescription
No parameters.
search_group_by_id_deprecated Write

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

Lua path
app.integrations.cockroachdb.search_group_by_id_deprecated
Full name
cockroachdb.cockroachdb_get_group2
ParameterTypeRequiredDescription
No parameters.
list_scim_resource_types Read

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

Lua path
app.integrations.cockroachdb.list_scim_resource_types
Full name
cockroachdb.cockroachdb_get_resource_types
ParameterTypeRequiredDescription
No parameters.
get_scim_resource_type_by_id Read

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

Lua path
app.integrations.cockroachdb.get_scim_resource_type_by_id
Full name
cockroachdb.cockroachdb_get_resource_type
ParameterTypeRequiredDescription
No parameters.
list_scim_schemas Read

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

Lua path
app.integrations.cockroachdb.list_scim_schemas
Full name
cockroachdb.cockroachdb_get_schemas
ParameterTypeRequiredDescription
No parameters.
get_scim_schema_by_id Read

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

Lua path
app.integrations.cockroachdb.get_scim_schema_by_id
Full name
cockroachdb.cockroachdb_get_schema
ParameterTypeRequiredDescription
No parameters.
return_scim_service_provider_configuration Read

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

Lua path
app.integrations.cockroachdb.return_scim_service_provider_configuration
Full name
cockroachdb.cockroachdb_get_service_provider_config
ParameterTypeRequiredDescription
No parameters.
list_users Read

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

Lua path
app.integrations.cockroachdb.list_users
Full name
cockroachdb.cockroachdb_get_users
ParameterTypeRequiredDescription
No parameters.
create_user Write

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

Lua path
app.integrations.cockroachdb.create_user
Full name
cockroachdb.cockroachdb_create_user
ParameterTypeRequiredDescription
No parameters.
search_users Write

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

Lua path
app.integrations.cockroachdb.search_users
Full name
cockroachdb.cockroachdb_search_users
ParameterTypeRequiredDescription
No parameters.
search_user_deprecated Write

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

Lua path
app.integrations.cockroachdb.search_user_deprecated
Full name
cockroachdb.cockroachdb_get_users2
ParameterTypeRequiredDescription
No parameters.
get_user_by_id Read

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

Lua path
app.integrations.cockroachdb.get_user_by_id
Full name
cockroachdb.cockroachdb_get_user
ParameterTypeRequiredDescription
No parameters.
update_user_by_supplying_all_values_user_object Write

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

Lua path
app.integrations.cockroachdb.update_user_by_supplying_all_values_user_object
Full name
cockroachdb.cockroachdb_update_user
ParameterTypeRequiredDescription
No parameters.
patch_user_by_supplying_partial_updates Write

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

Lua path
app.integrations.cockroachdb.patch_user_by_supplying_partial_updates
Full name
cockroachdb.cockroachdb_patch_user
ParameterTypeRequiredDescription
No parameters.
delete_user_based_id Write

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

Lua path
app.integrations.cockroachdb.delete_user_based_id
Full name
cockroachdb.cockroachdb_delete_user
ParameterTypeRequiredDescription
No parameters.
search_user_by_id Write

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

Lua path
app.integrations.cockroachdb.search_user_by_id
Full name
cockroachdb.cockroachdb_search_user
ParameterTypeRequiredDescription
No parameters.
search_user_by_id_deprecated Write

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

Lua path
app.integrations.cockroachdb.search_user_by_id_deprecated
Full name
cockroachdb.cockroachdb_get_user2
ParameterTypeRequiredDescription
No parameters.
list_api_keys Read

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

Lua path
app.integrations.cockroachdb.list_api_keys
Full name
cockroachdb.cockroachdb_list_api_keys
ParameterTypeRequiredDescription
No parameters.
create_new_api_key Write

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

Lua path
app.integrations.cockroachdb.create_new_api_key
Full name
cockroachdb.cockroachdb_create_api_key
ParameterTypeRequiredDescription
No parameters.
get_api_key_by_id Read

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

Lua path
app.integrations.cockroachdb.get_api_key_by_id
Full name
cockroachdb.cockroachdb_get_api_key
ParameterTypeRequiredDescription
No parameters.
update_api_key Write

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

Lua path
app.integrations.cockroachdb.update_api_key
Full name
cockroachdb.cockroachdb_update_api_key
ParameterTypeRequiredDescription
No parameters.
delete_api_key Write

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

Lua path
app.integrations.cockroachdb.delete_api_key
Full name
cockroachdb.cockroachdb_delete_api_key
ParameterTypeRequiredDescription
No parameters.
list_audit_logs Read

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

Lua path
app.integrations.cockroachdb.list_audit_logs
Full name
cockroachdb.cockroachdb_list_audit_logs
ParameterTypeRequiredDescription
No parameters.
list_available_major_cluster_versions Read

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

Lua path
app.integrations.cockroachdb.list_available_major_cluster_versions
Full name
cockroachdb.cockroachdb_list_major_cluster_versions
ParameterTypeRequiredDescription
No parameters.
list_clusters_organization Read

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

Lua path
app.integrations.cockroachdb.list_clusters_organization
Full name
cockroachdb.cockroachdb_list_clusters
ParameterTypeRequiredDescription
No parameters.
create_and_initialize_new_cluster Write

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

Lua path
app.integrations.cockroachdb.create_and_initialize_new_cluster
Full name
cockroachdb.cockroachdb_create_cluster
ParameterTypeRequiredDescription
No parameters.
list_regions_available_new_clusters_and_nodes Read

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

Lua path
app.integrations.cockroachdb.list_regions_available_new_clusters_and_nodes
Full name
cockroachdb.cockroachdb_list_available_regions
ParameterTypeRequiredDescription
No parameters.
get_extended_information_about_cluster Read

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

Lua path
app.integrations.cockroachdb.get_extended_information_about_cluster
Full name
cockroachdb.cockroachdb_get_cluster
ParameterTypeRequiredDescription
No parameters.
scale_edit_or_upgrade_cluster Write

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

Lua path
app.integrations.cockroachdb.scale_edit_or_upgrade_cluster
Full name
cockroachdb.cockroachdb_update_cluster
ParameterTypeRequiredDescription
No parameters.
delete_cluster_and_all_its_data Write

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

Lua path
app.integrations.cockroachdb.delete_cluster_and_all_its_data
Full name
cockroachdb.cockroachdb_delete_cluster
ParameterTypeRequiredDescription
No parameters.
list_cluster_backups Read

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

Lua path
app.integrations.cockroachdb.list_cluster_backups
Full name
cockroachdb.cockroachdb_list_backups
ParameterTypeRequiredDescription
No parameters.
get_backup_configuration_cluster Read

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

Lua path
app.integrations.cockroachdb.get_backup_configuration_cluster
Full name
cockroachdb.cockroachdb_get_backup_configuration
ParameterTypeRequiredDescription
No parameters.
update_backup_configuration_cluster Write

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

Lua path
app.integrations.cockroachdb.update_backup_configuration_cluster
Full name
cockroachdb.cockroachdb_update_backup_configuration
ParameterTypeRequiredDescription
No parameters.
list_all_blackout_windows_cluster Read

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

Lua path
app.integrations.cockroachdb.list_all_blackout_windows_cluster
Full name
cockroachdb.cockroachdb_list_blackout_windows
ParameterTypeRequiredDescription
No parameters.
create_blackout_window_cluster Write

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

Lua path
app.integrations.cockroachdb.create_blackout_window_cluster
Full name
cockroachdb.cockroachdb_create_blackout_window
ParameterTypeRequiredDescription
No parameters.
get_blackout_window_by_its_id_cluster Read

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

Lua path
app.integrations.cockroachdb.get_blackout_window_by_its_id_cluster
Full name
cockroachdb.cockroachdb_get_blackout_window
ParameterTypeRequiredDescription
No parameters.
update_blackout_window_cluster Write

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

Lua path
app.integrations.cockroachdb.update_blackout_window_cluster
Full name
cockroachdb.cockroachdb_update_blackout_window
ParameterTypeRequiredDescription
No parameters.
delete_blackout_window_cluster Write

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

Lua path
app.integrations.cockroachdb.delete_blackout_window_cluster
Full name
cockroachdb.cockroachdb_delete_blackout_window
ParameterTypeRequiredDescription
No parameters.
get_client_ca_cert_information_cluster Read

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

Lua path
app.integrations.cockroachdb.get_client_ca_cert_information_cluster
Full name
cockroachdb.cockroachdb_get_client_c_a_cert
ParameterTypeRequiredDescription
No parameters.
set_client_ca_cert_cluster Write

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

Lua path
app.integrations.cockroachdb.set_client_ca_cert_cluster
Full name
cockroachdb.cockroachdb_set_client_c_a_cert
ParameterTypeRequiredDescription
No parameters.
update_client_ca_cert_cluster Write

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

Lua path
app.integrations.cockroachdb.update_client_ca_cert_cluster
Full name
cockroachdb.cockroachdb_update_client_c_a_cert
ParameterTypeRequiredDescription
No parameters.
delete_client_ca_cert_cluster Write

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

Lua path
app.integrations.cockroachdb.delete_client_ca_cert_cluster
Full name
cockroachdb.cockroachdb_delete_client_c_a_cert
ParameterTypeRequiredDescription
No parameters.
enable_cmek_cluster Write

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

Lua path
app.integrations.cockroachdb.enable_cmek_cluster
Full name
cockroachdb.cockroachdb_enable_c_m_e_k_spec
ParameterTypeRequiredDescription
No parameters.
enable_or_update_cmek_spec_cluster Write

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

Lua path
app.integrations.cockroachdb.enable_or_update_cmek_spec_cluster
Full name
cockroachdb.cockroachdb_update_c_m_e_k_spec
ParameterTypeRequiredDescription
No parameters.
get_formatted_generic_connection_string_cluster Read

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

Lua path
app.integrations.cockroachdb.get_formatted_generic_connection_string_cluster
Full name
cockroachdb.cockroachdb_get_connection_string
ParameterTypeRequiredDescription
No parameters.
list_databases_cluster Read

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

Lua path
app.integrations.cockroachdb.list_databases_cluster
Full name
cockroachdb.cockroachdb_list_databases
ParameterTypeRequiredDescription
No parameters.
create_new_database Write

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

Lua path
app.integrations.cockroachdb.create_new_database
Full name
cockroachdb.cockroachdb_create_database
ParameterTypeRequiredDescription
No parameters.
update_database Write

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

Lua path
app.integrations.cockroachdb.update_database
Full name
cockroachdb.cockroachdb_edit_database2
ParameterTypeRequiredDescription
No parameters.
update_database Write

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

Lua path
app.integrations.cockroachdb.update_database
Full name
cockroachdb.cockroachdb_edit_database
ParameterTypeRequiredDescription
No parameters.
delete_database Write

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

Lua path
app.integrations.cockroachdb.delete_database
Full name
cockroachdb.cockroachdb_delete_database
ParameterTypeRequiredDescription
No parameters.
get_disruption_specifications_cluster Read

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

Lua path
app.integrations.cockroachdb.get_disruption_specifications_cluster
Full name
cockroachdb.cockroachdb_get_cluster_disruption_info
ParameterTypeRequiredDescription
No parameters.
update_disruption_specifications_cluster Write

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

Lua path
app.integrations.cockroachdb.update_disruption_specifications_cluster
Full name
cockroachdb.cockroachdb_update_cluster_disruption
ParameterTypeRequiredDescription
No parameters.
get_log_export_configuration_cluster Read

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

Lua path
app.integrations.cockroachdb.get_log_export_configuration_cluster
Full name
cockroachdb.cockroachdb_get_log_export_info
ParameterTypeRequiredDescription
No parameters.
create_or_update_log_export_configuration_cluster Write

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

Lua path
app.integrations.cockroachdb.create_or_update_log_export_configuration_cluster
Full name
cockroachdb.cockroachdb_enable_log_export
ParameterTypeRequiredDescription
No parameters.
delete_log_export_configuration_cluster Write

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

Lua path
app.integrations.cockroachdb.delete_log_export_configuration_cluster
Full name
cockroachdb.cockroachdb_delete_log_export
ParameterTypeRequiredDescription
No parameters.
get_maintenance_window_cluster Read

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

Lua path
app.integrations.cockroachdb.get_maintenance_window_cluster
Full name
cockroachdb.cockroachdb_get_maintenance_window
ParameterTypeRequiredDescription
No parameters.
set_maintenance_window_cluster Write

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

Lua path
app.integrations.cockroachdb.set_maintenance_window_cluster
Full name
cockroachdb.cockroachdb_set_maintenance_window
ParameterTypeRequiredDescription
No parameters.
delete_maintenance_window_cluster Write

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

Lua path
app.integrations.cockroachdb.delete_maintenance_window_cluster
Full name
cockroachdb.cockroachdb_delete_maintenance_window
ParameterTypeRequiredDescription
No parameters.
get_cloudwatch_metric_export_configuration_cluster Read

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

Lua path
app.integrations.cockroachdb.get_cloudwatch_metric_export_configuration_cluster
Full name
cockroachdb.cockroachdb_get_cloud_watch_metric_export_info
ParameterTypeRequiredDescription
No parameters.
create_or_update_cloudwatch_metric_export_configuration_cluster Write

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

Lua path
app.integrations.cockroachdb.create_or_update_cloudwatch_metric_export_configuration_cluster
Full name
cockroachdb.cockroachdb_enable_cloud_watch_metric_export
ParameterTypeRequiredDescription
No parameters.
delete_cloudwatch_metric_export_configuration_cluster Write

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

Lua path
app.integrations.cockroachdb.delete_cloudwatch_metric_export_configuration_cluster
Full name
cockroachdb.cockroachdb_delete_cloud_watch_metric_export
ParameterTypeRequiredDescription
No parameters.
get_datadog_metric_export_configuration_cluster Read

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

Lua path
app.integrations.cockroachdb.get_datadog_metric_export_configuration_cluster
Full name
cockroachdb.cockroachdb_get_datadog_metric_export_info
ParameterTypeRequiredDescription
No parameters.
create_or_update_datadog_metric_export_configuration_cluster Write

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

Lua path
app.integrations.cockroachdb.create_or_update_datadog_metric_export_configuration_cluster
Full name
cockroachdb.cockroachdb_enable_datadog_metric_export
ParameterTypeRequiredDescription
No parameters.
delete_datadog_metric_export_configuration_cluster Write

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

Lua path
app.integrations.cockroachdb.delete_datadog_metric_export_configuration_cluster
Full name
cockroachdb.cockroachdb_delete_datadog_metric_export
ParameterTypeRequiredDescription
No parameters.
get_prometheus_metric_export_configuration_cluster Read

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

Lua path
app.integrations.cockroachdb.get_prometheus_metric_export_configuration_cluster
Full name
cockroachdb.cockroachdb_get_prometheus_metric_export_info
ParameterTypeRequiredDescription
No parameters.
enable_prometheus_metric_export_cluster Write

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

Lua path
app.integrations.cockroachdb.enable_prometheus_metric_export_cluster
Full name
cockroachdb.cockroachdb_enable_prometheus_metric_export
ParameterTypeRequiredDescription
No parameters.
disable_prometheus_metric_export_cluster Write

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

Lua path
app.integrations.cockroachdb.disable_prometheus_metric_export_cluster
Full name
cockroachdb.cockroachdb_delete_prometheus_metric_export
ParameterTypeRequiredDescription
No parameters.
get_ip_allowlist_and_propagation_status_cluster Read

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

Lua path
app.integrations.cockroachdb.get_ip_allowlist_and_propagation_status_cluster
Full name
cockroachdb.cockroachdb_list_allowlist_entries
ParameterTypeRequiredDescription
No parameters.
add_new_cidr_address_ip_allowlist Write

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

Lua path
app.integrations.cockroachdb.add_new_cidr_address_ip_allowlist
Full name
cockroachdb.cockroachdb_add_allowlist_entry
ParameterTypeRequiredDescription
No parameters.
add_new_cidr_address_ip_allowlist Write

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

Lua path
app.integrations.cockroachdb.add_new_cidr_address_ip_allowlist
Full name
cockroachdb.cockroachdb_add_allowlist_entry2
ParameterTypeRequiredDescription
No parameters.
update_ip_allowlist_entry Write

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

Lua path
app.integrations.cockroachdb.update_ip_allowlist_entry
Full name
cockroachdb.cockroachdb_update_allowlist_entry
ParameterTypeRequiredDescription
No parameters.
delete_ip_allowlist_entry Write

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

Lua path
app.integrations.cockroachdb.delete_ip_allowlist_entry
Full name
cockroachdb.cockroachdb_delete_allowlist_entry
ParameterTypeRequiredDescription
No parameters.
list_all_awsendpointconnections_cluster Read

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

Lua path
app.integrations.cockroachdb.list_all_awsendpointconnections_cluster
Full name
cockroachdb.cockroachdb_list_aws_endpoint_connections
ParameterTypeRequiredDescription
No parameters.
set_aws_endpoint_connection_state Write

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

Lua path
app.integrations.cockroachdb.set_aws_endpoint_connection_state
Full name
cockroachdb.cockroachdb_set_aws_endpoint_connection_state
ParameterTypeRequiredDescription
No parameters.
list_egress_private_endpoints Read

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

Lua path
app.integrations.cockroachdb.list_egress_private_endpoints
Full name
cockroachdb.cockroachdb_list_egress_private_endpoints
ParameterTypeRequiredDescription
No parameters.
create_egress_private_endpoint Write

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

Lua path
app.integrations.cockroachdb.create_egress_private_endpoint
Full name
cockroachdb.cockroachdb_create_egress_private_endpoint
ParameterTypeRequiredDescription
No parameters.
get_egress_private_endpoint Read

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

Lua path
app.integrations.cockroachdb.get_egress_private_endpoint
Full name
cockroachdb.cockroachdb_get_egress_private_endpoint
ParameterTypeRequiredDescription
No parameters.
update_egress_private_endpoint Write

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

Lua path
app.integrations.cockroachdb.update_egress_private_endpoint
Full name
cockroachdb.cockroachdb_update_egress_private_endpoint
ParameterTypeRequiredDescription
No parameters.
delete_egress_private_endpoint Write

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

Lua path
app.integrations.cockroachdb.delete_egress_private_endpoint
Full name
cockroachdb.cockroachdb_delete_egress_private_endpoint
ParameterTypeRequiredDescription
No parameters.
update_egress_private_endpoint_domain_names_this_endpoint_is_deprecated_favor_patch_api_v1_clusters_cluster_id_networking_egress_private_endpoints_id_and_will_be_removed_future_version Write

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

Lua path
app.integrations.cockroachdb.update_egress_private_endpoint_domain_names_this_endpoint_is_deprecated_favor_patch_api_v1_clusters_cluster_id_networking_egress_private_endpoints_id_and_will_be_removed_future_version
Full name
cockroachdb.cockroachdb_update_egress_private_endpoint_domain_names
ParameterTypeRequiredDescription
No parameters.
list_all_egress_rules_associated_with_cluster Read

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

Lua path
app.integrations.cockroachdb.list_all_egress_rules_associated_with_cluster
Full name
cockroachdb.cockroachdb_list_egress_rules
ParameterTypeRequiredDescription
No parameters.
add_egress_rule Write

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

Lua path
app.integrations.cockroachdb.add_egress_rule
Full name
cockroachdb.cockroachdb_add_egress_rule
ParameterTypeRequiredDescription
No parameters.
outbound_traffic_management Write

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

Lua path
app.integrations.cockroachdb.outbound_traffic_management
Full name
cockroachdb.cockroachdb_set_egress_traffic_policy
ParameterTypeRequiredDescription
No parameters.
get_existing_egress_rule Read

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

Lua path
app.integrations.cockroachdb.get_existing_egress_rule
Full name
cockroachdb.cockroachdb_get_egress_rule
ParameterTypeRequiredDescription
No parameters.
edit_existing_egress_rule Write

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

Lua path
app.integrations.cockroachdb.edit_existing_egress_rule
Full name
cockroachdb.cockroachdb_edit_egress_rule
ParameterTypeRequiredDescription
No parameters.
delete_existing_egress_rule Write

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

Lua path
app.integrations.cockroachdb.delete_existing_egress_rule
Full name
cockroachdb.cockroachdb_delete_egress_rule
ParameterTypeRequiredDescription
No parameters.
list_all_connections_cluster_private_endpoint_service Read

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

Lua path
app.integrations.cockroachdb.list_all_connections_cluster_private_endpoint_service
Full name
cockroachdb.cockroachdb_list_private_endpoint_connections
ParameterTypeRequiredDescription
No parameters.
add_connection_cluster_private_endpoint_service Write

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

Lua path
app.integrations.cockroachdb.add_connection_cluster_private_endpoint_service
Full name
cockroachdb.cockroachdb_add_private_endpoint_connection
ParameterTypeRequiredDescription
No parameters.
delete_connection_from_cluster_private_endpoint_service Write

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

Lua path
app.integrations.cockroachdb.delete_connection_from_cluster_private_endpoint_service
Full name
cockroachdb.cockroachdb_delete_private_endpoint_connection
ParameterTypeRequiredDescription
No parameters.
list_all_privateendpointservices_cluster Read

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

Lua path
app.integrations.cockroachdb.list_all_privateendpointservices_cluster
Full name
cockroachdb.cockroachdb_list_private_endpoint_services
ParameterTypeRequiredDescription
No parameters.
create_all_privateendpointservices_cluster Write

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

Lua path
app.integrations.cockroachdb.create_all_privateendpointservices_cluster
Full name
cockroachdb.cockroachdb_create_private_endpoint_services
ParameterTypeRequiredDescription
No parameters.
list_all_private_endpoint_trusted_owners_cluster Read

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

Lua path
app.integrations.cockroachdb.list_all_private_endpoint_trusted_owners_cluster
Full name
cockroachdb.cockroachdb_list_private_endpoint_trusted_owners
ParameterTypeRequiredDescription
No parameters.
add_private_endpoint_trusted_owner_cluster Write

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

Lua path
app.integrations.cockroachdb.add_private_endpoint_trusted_owner_cluster
Full name
cockroachdb.cockroachdb_add_private_endpoint_trusted_owner
ParameterTypeRequiredDescription
No parameters.
get_private_endpoint_trusted_owner_entry_cluster Read

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

Lua path
app.integrations.cockroachdb.get_private_endpoint_trusted_owner_entry_cluster
Full name
cockroachdb.cockroachdb_get_private_endpoint_trusted_owner
ParameterTypeRequiredDescription
No parameters.
remove_private_endpoint_trusted_owner_from_cluster Write

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

Lua path
app.integrations.cockroachdb.remove_private_endpoint_trusted_owner_from_cluster
Full name
cockroachdb.cockroachdb_remove_private_endpoint_trusted_owner
ParameterTypeRequiredDescription
No parameters.
list_nodes_cluster Read

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

Lua path
app.integrations.cockroachdb.list_nodes_cluster
Full name
cockroachdb.cockroachdb_list_cluster_nodes
ParameterTypeRequiredDescription
No parameters.
list_restore_jobs Read

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

Lua path
app.integrations.cockroachdb.list_restore_jobs
Full name
cockroachdb.cockroachdb_list_restores
ParameterTypeRequiredDescription
No parameters.
view_restore_job Read

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

Lua path
app.integrations.cockroachdb.view_restore_job
Full name
cockroachdb.cockroachdb_get_restore
ParameterTypeRequiredDescription
No parameters.
list_sql_users_cluster Read

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

Lua path
app.integrations.cockroachdb.list_sql_users_cluster
Full name
cockroachdb.cockroachdb_list_users
ParameterTypeRequiredDescription
No parameters.
create_new_sql_user Write

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

Lua path
app.integrations.cockroachdb.create_new_sql_user
Full name
cockroachdb.cockroachdb_create_s_q_l_user
ParameterTypeRequiredDescription
No parameters.
delete_sql_user Write

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

Lua path
app.integrations.cockroachdb.delete_sql_user
Full name
cockroachdb.cockroachdb_delete_s_q_l_user
ParameterTypeRequiredDescription
No parameters.
update_sql_user_password Write

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

Lua path
app.integrations.cockroachdb.update_sql_user_password
Full name
cockroachdb.cockroachdb_update_s_q_l_user_password
ParameterTypeRequiredDescription
No parameters.
get_version_upgrade_deferral_policy_cluster Read

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

Lua path
app.integrations.cockroachdb.get_version_upgrade_deferral_policy_cluster
Full name
cockroachdb.cockroachdb_get_cluster_version_deferral
ParameterTypeRequiredDescription
No parameters.
set_version_upgrade_deferral_policy_cluster Write

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

Lua path
app.integrations.cockroachdb.set_version_upgrade_deferral_policy_cluster
Full name
cockroachdb.cockroachdb_set_cluster_version_deferral
ParameterTypeRequiredDescription
No parameters.
create_restore Write

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

Lua path
app.integrations.cockroachdb.create_restore
Full name
cockroachdb.cockroachdb_create_restore
ParameterTypeRequiredDescription
No parameters.
list_folders_owned_by_organization Read

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

Lua path
app.integrations.cockroachdb.list_folders_owned_by_organization
Full name
cockroachdb.cockroachdb_list_folders
ParameterTypeRequiredDescription
No parameters.
create_folder Write

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

Lua path
app.integrations.cockroachdb.create_folder
Full name
cockroachdb.cockroachdb_create_folder
ParameterTypeRequiredDescription
No parameters.
get_folder_info_folder Read

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

Lua path
app.integrations.cockroachdb.get_folder_info_folder
Full name
cockroachdb.cockroachdb_get_folder
ParameterTypeRequiredDescription
No parameters.
update_folder Write

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

Lua path
app.integrations.cockroachdb.update_folder
Full name
cockroachdb.cockroachdb_update_folder
ParameterTypeRequiredDescription
No parameters.
delete_folder Write

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

Lua path
app.integrations.cockroachdb.delete_folder
Full name
cockroachdb.cockroachdb_delete_folder
ParameterTypeRequiredDescription
No parameters.
list_contents_folder Read

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

Lua path
app.integrations.cockroachdb.list_contents_folder
Full name
cockroachdb.cockroachdb_list_folder_contents
ParameterTypeRequiredDescription
No parameters.
list_invoices_given_organization Read

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

Lua path
app.integrations.cockroachdb.list_invoices_given_organization
Full name
cockroachdb.cockroachdb_list_invoices
ParameterTypeRequiredDescription
No parameters.
get_specific_invoice_organization Read

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

Lua path
app.integrations.cockroachdb.get_specific_invoice_organization
Full name
cockroachdb.cockroachdb_get_invoice
ParameterTypeRequiredDescription
No parameters.
list_all_jwt_issuers Read

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

Lua path
app.integrations.cockroachdb.list_all_jwt_issuers
Full name
cockroachdb.cockroachdb_list_j_w_t_issuers
ParameterTypeRequiredDescription
No parameters.
add_jwt_issuer Write

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

Lua path
app.integrations.cockroachdb.add_jwt_issuer
Full name
cockroachdb.cockroachdb_add_j_w_t_issuer
ParameterTypeRequiredDescription
No parameters.
get_jwt_issuer Read

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

Lua path
app.integrations.cockroachdb.get_jwt_issuer
Full name
cockroachdb.cockroachdb_get_j_w_t_issuer
ParameterTypeRequiredDescription
No parameters.
update_jwt_issuer Write

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

Lua path
app.integrations.cockroachdb.update_jwt_issuer
Full name
cockroachdb.cockroachdb_update_j_w_t_issuer
ParameterTypeRequiredDescription
No parameters.
delete_jwt_issuer Write

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

Lua path
app.integrations.cockroachdb.delete_jwt_issuer
Full name
cockroachdb.cockroachdb_delete_j_w_t_issuer
ParameterTypeRequiredDescription
No parameters.
get_information_about_caller_organization Read

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

Lua path
app.integrations.cockroachdb.get_information_about_caller_organization
Full name
cockroachdb.cockroachdb_get_organization_info
ParameterTypeRequiredDescription
No parameters.
list_physical_replication_streams Read

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

Lua path
app.integrations.cockroachdb.list_physical_replication_streams
Full name
cockroachdb.cockroachdb_list_physical_replication_streams
ParameterTypeRequiredDescription
No parameters.
create_physical_replication_stream Write

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

Lua path
app.integrations.cockroachdb.create_physical_replication_stream
Full name
cockroachdb.cockroachdb_create_physical_replication_stream
ParameterTypeRequiredDescription
No parameters.
get_physical_replication_stream Read

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

Lua path
app.integrations.cockroachdb.get_physical_replication_stream
Full name
cockroachdb.cockroachdb_get_physical_replication_stream
ParameterTypeRequiredDescription
No parameters.
update_physical_replication_stream Write

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

Lua path
app.integrations.cockroachdb.update_physical_replication_stream
Full name
cockroachdb.cockroachdb_update_physical_replication_stream
ParameterTypeRequiredDescription
No parameters.
list_all_rolegrants Read

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

Lua path
app.integrations.cockroachdb.list_all_rolegrants
Full name
cockroachdb.cockroachdb_list_role_grants
ParameterTypeRequiredDescription
No parameters.
get_all_role_grants_user Read

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

Lua path
app.integrations.cockroachdb.get_all_role_grants_user
Full name
cockroachdb.cockroachdb_get_all_roles_for_user
ParameterTypeRequiredDescription
No parameters.
replace_roles_user_or_service_account_with_exactly_those_provided Write

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

Lua path
app.integrations.cockroachdb.replace_roles_user_or_service_account_with_exactly_those_provided
Full name
cockroachdb.cockroachdb_set_roles_for_user
ParameterTypeRequiredDescription
No parameters.
add_role_user_or_service_account Write

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

Lua path
app.integrations.cockroachdb.add_role_user_or_service_account
Full name
cockroachdb.cockroachdb_add_user_to_role
ParameterTypeRequiredDescription
No parameters.
remove_role_from_user_or_service_account Write

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

Lua path
app.integrations.cockroachdb.remove_role_from_user_or_service_account
Full name
cockroachdb.cockroachdb_remove_user_from_role
ParameterTypeRequiredDescription
No parameters.
list_service_accounts_organization Read

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

Lua path
app.integrations.cockroachdb.list_service_accounts_organization
Full name
cockroachdb.cockroachdb_list_service_accounts
ParameterTypeRequiredDescription
No parameters.
create_service_account Write

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

Lua path
app.integrations.cockroachdb.create_service_account
Full name
cockroachdb.cockroachdb_create_service_account
ParameterTypeRequiredDescription
No parameters.
get_service_account_by_id Read

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

Lua path
app.integrations.cockroachdb.get_service_account_by_id
Full name
cockroachdb.cockroachdb_get_service_account
ParameterTypeRequiredDescription
No parameters.
update_service_account Write

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

Lua path
app.integrations.cockroachdb.update_service_account
Full name
cockroachdb.cockroachdb_update_service_account
ParameterTypeRequiredDescription
No parameters.
delete_service_account Write

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

Lua path
app.integrations.cockroachdb.delete_service_account
Full name
cockroachdb.cockroachdb_delete_service_account
ParameterTypeRequiredDescription
No parameters.
search_person_users_by_email_address Read

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

Lua path
app.integrations.cockroachdb.search_person_users_by_email_address
Full name
cockroachdb.cockroachdb_get_person_users_by_email
ParameterTypeRequiredDescription
No parameters.