# CockroachDB: Cloud Deployments Cloud API Reference 2023-04-10 ## 2023-04-10 ### Overview - [CockroachDB Cloud API](https://docs.cockroachlabs.com/docs/api/cloud/2023-04-10.md) ### Endpoints #### SCIM - [List groups](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/list-groups.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Create a group](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/create-a-group.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search groups](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-groups.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search groups](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-groups-1.md): 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. - [Get a group by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/get-a-group-by-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Update a group by supplying all values of the user object](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/update-a-group-by-supplying-all-values-of-the-user-object.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Delete a group based on ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/delete-a-group-based-on-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search a group by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-a-group-by-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search a group by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-a-group-by-id-1.md): 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. - [List the SCIM resource types](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/list-the-scim-resource-types.md): This endpoint may be used by any member of the organization. - [Get a SCIM resource type by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/get-a-scim-resource-type-by-id.md): This endpoint may be used by any member of the organization. - [List the SCIM schemas](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/list-the-scim-schemas.md): This endpoint may be used by any member of the organization. - [Get a SCIM schema by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/get-a-scim-schema-by-id.md): This endpoint may be used by any member of the organization. - [Return the SCIM Service Provider configuration](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/return-the-scim-service-provider-configuration.md): This endpoint may be used by any member of the organization. - [List Users](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/list-users.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Create a user](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/create-a-user.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search User](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-user.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search Users](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-users.md): 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. - [Get a user by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/get-a-user-by-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Update a user by supplying all values of the user object](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/update-a-user-by-supplying-all-values-of-the-user-object.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Delete a user based on ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/delete-a-user-based-on-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search for a user by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-for-a-user-by-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Search for a user by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/scim/search-for-a-user-by-id-1.md): 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. #### API Keys - [List API Keys](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/api-keys/list-api-keys.md): Sort order: created_at - [Create a new API Key](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/api-keys/create-a-new-api-key.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Get an API Key by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/api-keys/get-an-api-key-by-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - [Delete an API Key](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/api-keys/delete-an-api-key.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Update an API Key](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/api-keys/update-an-api-key.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN #### OpenID Connect Configuration - [List all API OIDC configurations](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/list-all-api-oidc-configurations.md): This endpoint has been deprecated in favor of /jwt-issuers - [Create an API OIDC configuration](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/create-an-api-oidc-configuration.md): This endpoint has been deprecated in favor of /jwt-issuers - [Get an API OIDC configuration](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/get-an-api-oidc-configuration.md): This endpoint has been deprecated in favor of /jwt-issuers - [Update an API OIDC configuration](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/update-an-api-oidc-configuration.md): This endpoint has been deprecated in favor of /jwt-issuers - [Delete an API OIDC configuration](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/delete-an-api-oidc-configuration.md): This endpoint has been deprecated in favor of /jwt-issuers #### Audit Logs - [List audit logs](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/audit-logs/list-audit-logs.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN #### Clusters - [List available major cluster versions](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/list-available-major-cluster-versions.md): Sort order: Version number descending - [List clusters owned by an organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/list-clusters-owned-by-an-organization.md): Sort order: Cluster name - [Create and initialize a new cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/create-and-initialize-a-new-cluster.md): Can be used by the following roles assigned at the organization scope: - CLUSTER_ADMIN - CLUSTER_CREATOR - [List the regions available for new clusters and nodes](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/list-the-regions-available-for-new-clusters-and-nodes.md): Sort order: Distance (based on client IP address) - [Get extended information about a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/get-extended-information-about-a-cluster.md): 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 - [Delete a cluster and all of its data](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/delete-a-cluster-and-all-of-its-data.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - [Scale, edit or upgrade a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/scale-edit-or-upgrade-a-cluster.md): 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`. To begin the upgrade, PATCH `{"upgrade_status": "MAJOR_UPGRADE_RUNNING"}` to this… - [Get a formatted generic connection string for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/get-a-formatted-generic-connection-string-for-a-cluster.md): 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 - [List nodes for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/clusters/list-nodes-for-a-cluster.md): Sort order: Region name, node name #### Client CA Certificates - [Get Client CA Cert information for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/client-ca-certificates/get-client-ca-cert-information-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Set Client CA Cert for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/client-ca-certificates/set-client-ca-cert-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete Client CA Cert for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/client-ca-certificates/delete-client-ca-cert-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Update Client CA Cert for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/client-ca-certificates/update-client-ca-cert-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### Customer-managed Encryption Keys - [Get CMEK-related information for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/get-cmek-related-information-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Enable or update the CMEK spec for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/enable-or-update-the-cmek-spec-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Enable CMEK for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/enable-cmek-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Update the CMEK-related status for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/update-the-cmek-related-status-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### Databases - [List databases for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/databases/list-databases-for-a-cluster.md): Sort order: Database name ascending - [Create a new database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/databases/create-a-new-database.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Update a database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/databases/update-a-database.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete a database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/databases/delete-a-database.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Update a database](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/databases/update-a-database-1.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### Log Export - [Get the Log Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/log-export/get-the-log-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Create or update the Log Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/log-export/create-or-update-the-log-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete the Log Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/log-export/delete-the-log-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - ORG_ADMIN - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### Maintenance Windows - [Get the maintenance window for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/maintenance-windows/get-the-maintenance-window-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Set the maintenance window for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/maintenance-windows/set-the-maintenance-window-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete the maintenance window for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/maintenance-windows/delete-the-maintenance-window-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### Metric Export - [Get the CloudWatch Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/get-the-cloudwatch-metric-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Create or update the CloudWatch Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/create-or-update-the-cloudwatch-metric-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete the CloudWatch Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/delete-the-cloudwatch-metric-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Get the Datadog Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/get-the-datadog-metric-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Create or update the Datadog Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/create-or-update-the-datadog-metric-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete the Datadog Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/delete-the-datadog-metric-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Get the Prometheus Metric Export configuration for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/get-the-prometheus-metric-export-configuration-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Enable Prometheus Metric Export for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/enable-prometheus-metric-export-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Disable Prometheus Metric Export for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/metric-export/disable-prometheus-metric-export-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### IP Allowlists - [Get the IP allowlist and propagation status for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/ip-allowlists/get-the-ip-allowlist-and-propagation-status-for-a-cluster.md): Sort order: CIDR address - [Add a new CIDR address to the IP allowlist](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Add a new CIDR address to the IP allowlist](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist-1.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete an IP allowlist entry](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/ip-allowlists/delete-an-ip-allowlist-entry.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Update an IP allowlist entry](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/ip-allowlists/update-an-ip-allowlist-entry.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### Private Endpoint Services - [List all AwsEndpointConnections for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-awsendpointconnections-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Set the AWS Endpoint Connection state](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/set-the-aws-endpoint-connection-state.md): The "status" in the response does not reflect the latest post-update status, but rather the status before the state is transitioned. - [List all connections to a cluster's private endpoint service.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-connections-to-a-clusters-private-endpoint-service.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Add a connection to a cluster's private endpoint service.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/add-a-connection-to-a-clusters-private-endpoint-service.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete a connection from a cluster's private endpoint service.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/delete-a-connection-from-a-clusters-private-endpoint-service.md): 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. - [List all PrivateEndpointServices for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-privateendpointservices-for-a-cluster.md): The internal_dns property from the regions field in the ListClusters response can be used to connect to PrivateEndpointServices. - [Create all PrivateEndpointServices for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/create-all-privateendpointservices-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [List all private endpoint trusted owners for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-private-endpoint-trusted-owners-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Add a private endpoint trusted owner to a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/add-a-private-endpoint-trusted-owner-to-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - [Get a private endpoint trusted owner entry for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/get-a-private-endpoint-trusted-owner-entry-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Remove a private endpoint trusted owner from a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/private-endpoint-services/remove-a-private-endpoint-trusted-owner-from-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN #### Egress Rules - [List all egress rules associated with a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/egress-rules/list-all-egress-rules-associated-with-a-cluster.md): Sort order: Name - [Add an egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/egress-rules/add-an-egress-rule.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Outbound traffic management](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/egress-rules/outbound-traffic-management.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Get an existing egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/egress-rules/get-an-existing-egress-rule.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Delete an existing egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/egress-rules/delete-an-existing-egress-rule.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Edit an existing egress rule](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/egress-rules/edit-an-existing-egress-rule.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### SQL Users - [List SQL users for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/sql-users/list-sql-users-for-a-cluster.md): Sort order: Username - [Create a new SQL user](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/sql-users/create-a-new-sql-user.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - [Delete a SQL user](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/sql-users/delete-a-sql-user.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - [Update a SQL user's password](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/sql-users/update-a-sql-users-password.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN #### Version Deferral - [Get the version upgrade deferral policy for a cluster.](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/version-deferral/get-the-version-upgrade-deferral-policy-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER - [Set the version upgrade deferral policy for a cluster](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/version-deferral/set-the-version-upgrade-deferral-policy-for-a-cluster.md): Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER #### Folders - [List folders owned by an organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/folders/list-folders-owned-by-an-organization.md): Sort order: Folder name - [Create a folder](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/folders/create-a-folder.md): Can be used by the following roles assigned at the organization or folder scope: - FOLDER_ADMIN - [Get folder info for a folder](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/folders/get-folder-info-for-a-folder.md): 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 - [Delete a folder](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/folders/delete-a-folder.md): Can be used by the following roles assigned at the organization or folder scope: - FOLDER_ADMIN - [Update a folder](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/folders/update-a-folder.md): Can be used by the following roles assigned at the organization or folder scope: - FOLDER_ADMIN - FOLDER_MOVER - [List contents of a folder](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/folders/list-contents-of-a-folder.md): Set `folder_id` to 'root' to list root level contents. Sort order: Folders sorted by name, followed by Clusters sorted by name. #### Billing - [List invoices for a given organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/billing/list-invoices-for-a-given-organization.md): Sort order: invoice start date ascending - [Get a specific invoice for an organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/billing/get-a-specific-invoice-for-an-organization.md): Can be used by the following roles assigned at the organization scope: - BILLING_COORDINATOR - CLUSTER_ADMIN #### JWT Issuers - [List all JWT Issuers](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/jwt-issuers/list-all-jwt-issuers.md): Lists all the JWT Issuer configurations registered for the CockroachDB Cloud organization - [Add a JWT Issuer](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/jwt-issuers/add-a-jwt-issuer.md): Registers a JWT Issuer with the CockroachDB Cloud to allow verifying JWTs during API authentication - [Get a JWT Issuer](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/jwt-issuers/get-a-jwt-issuer.md): Retrieves the JWT Issuer configuration - [Delete a JWT Issuer](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/jwt-issuers/delete-a-jwt-issuer.md): Deletes the JWT Issuer configuration - [Update a JWT Issuer](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/jwt-issuers/update-a-jwt-issuer.md): Updates the JWT Issuer configuration #### Organizations - [Get information about the caller's organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/organizations/get-information-about-the-callers-organization.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - ORG_MEMBER #### Role Management - [List all RoleGrants](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/role-management/list-all-rolegrants.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - FOLDER_ADMIN - [Get all Role Grants for a user](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/role-management/get-all-role-grants-for-a-user.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - FOLDER_ADMIN - [Replace the roles for a user or service account with exactly those provided](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/role-management/replace-the-roles-for-a-user-or-service-account-with-exactly-those-provided.md): Replace the entire role set for a user or service account by providing its user_id or service_account_id. - [Add a role to a user or service account](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/role-management/add-a-role-to-a-user-or-service-account.md): Add a single role to a user or service account by providing its user_id or service_account_id. - [Remove a role from a user or service account](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/role-management/remove-a-role-from-a-user-or-service-account.md): Remove a single role from a user or service account by providing its user_id or service_account_id. - [Search person users by email address](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/role-management/search-person-users-by-email-address.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - FOLDER_ADMIN #### Service Accounts - [List service accounts for an organization](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/service-accounts/list-service-accounts-for-an-organization.md): Sort order: Service account name - [Create a service account](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/service-accounts/create-a-service-account.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - [Get a service account by ID](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/service-accounts/get-a-service-account-by-id.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - CLUSTER_ADMIN - [Delete a service account](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/service-accounts/delete-a-service-account.md): Can be used by the following roles assigned at the organization scope: - ORG_ADMIN - [Update a service account](https://docs.cockroachlabs.com/docs/api/cloud/v1/2023-04-10/service-accounts/update-a-service-account.md): 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). ## OpenAPI Specs - [2023-04-10](/openapi/cloud/2023-04-10.json)