class

CB::Client

Inherits Reference / Object

Constructors

new(host : String = CB::HOST, bearer_token : String | Nil = nil)
Source

Instance methods

add_log_destination(cluster_id, ld)

Add a logger to a cluster.

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridloggers/create-logger

Source
backup_list(id : Identifier)
Source
backup_start(id : Identifier)
Source
backup_token(id : Identifier)
Source
create_cluster(params : ClusterCreateParams)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clusters/post

Source
create_firewall_rule(network_id, params : FirewallRuleCreateParams)

Add a firewall rule to a network.

https://docs.crunchybridge.com/api/network-firewall-rule#create-firewall-rule

Source
create_fork(params : ForkCreateParams)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridforks/post

Source
create_peering(network_id, params : PeeringCreateParams)
Source
create_replica(params : ReplicaCreateParams)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridreplicas/create-cluster-replica

Source
create_role(cluster_id : Identifier)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridroles/create-role

Source
create_role(cluster_id)
Source
create_saved_query(params : SavedQueryCreateParams)
Source
create_session(params : SessionCreateParams)

https://crunchybridgeapiinternal.docs.apiary.io/#reference/0/sessions/create-session

Source
create_session_intent(params : SessionIntentCreateParams)
Source
create_team(name : String)

Create a new team.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teams/create-team

Source
create_team_member(team_id, params : TeamMemberCreateParams)

Create (add) a team member.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamidmembers/create-team-member

Source
delete(path)
Source
delete_peering(network_id, peering_id)
Source
delete_role(cluster_id, role_name)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrolesrolename/delete-role

Source
destroy_cluster(id : String)
Source
destroy_cluster(id : Identifier)
Source
destroy_firewall_rule(network_id, firewall_rule_id)

Remove a firewall rule from a network.

https://docs.crunchybridge.com/api/network-firewall-rule#destroy-firewall-rule

Source
destroy_log_destination(cluster_id, logdest_id)

Remove a logger from a cluster.

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridloggersloggerid/destroy-logger

Source
destroy_saved_query(saved_query_id)
Source
destroy_team(id)

Delete a team.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamid/destroy-team

Source
detach_cluster(id : Identifier)
Source
disable_ha(id : Identifier) : CB::Model::Operation | Nil

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionsdisable-ha/disable-high-availability

Source
enable_ha(id : Identifier) : CB::Model::Operation | Nil

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionsenable-ha/enable-high-availability

Source
exec(method, path, body : String | Nil = nil)
Source
exec(method, path, body)
Source
flatten_clusters(clusters : Array(CB::Model::Cluster) | Nil, result = [] of CB::Model::Cluster)
Source
get(path)
Source
get_access_token
Source
get_account(secret : String | Nil = nil)

Get the account for the currently logged in user. https://crunchybridgeapi.docs.apiary.io/#reference/0/account/get-account

Source
get_cluster(id : Identifier)

Retrieve the cluster by id or by name.

Source
get_cluster(id : String | Nil)

TODO (abrightwell): track down why this must be nilable. Seems reasonable that it shouldn't require it to be.

Source
get_cluster_status(cluster_id)
Source
get_clusters(teams : Array(CB::Model::Team), flatten : Bool = false)
Source
get_clusters(team_id)
Source
get_clusters
Source
get_configuration_parameter(id : Identifier, name : String)

Get configuration parameter value

Source
get_firewall_rules(network_id)

List current firewall rules for a network.

https://docs.crunchybridge.com/api/network-firewall-rule#list-firewall-rules

Source
get_log_destinations(cluster_id)

List existing loggers for a cluster.

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridloggers/list-loggers

Source
get_network(id : Identifier)

Get a network by id or name.

https://crunchybridgeapi.docs.apiary.io/#reference/0/networksnetworkid

Source
get_network(id : String | Nil)
Source
get_networks(team : Identifier | Nil)

Get all networks for a team.

https://crunchybridgeapi.docs.apiary.io/#reference/0/networks/list-networks

Source
get_networks(teams : Array(CB::Model::Team))
Source
get_peering(network_id, peering_id)
Source
get_providers

List available providers.

https://crunchybridgeapi.docs.apiary.io/#reference/0/providers/list-providers

Source
get_role(cluster_id : Identifier, role_name : String)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrolesrolename/get-role

Source
get_role(cluster_id, role_name)
Source
get_saved_queries(cluster_id)
Source
get_saved_query(saved_query_id)
Source
get_session_intent(params : SessionIntentGetParams)
Source
get_team(id)

Retrieve details about a team.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamid/get-team

Source
get_team_cert(id)
Source
get_team_member(team_id, account_id)

Retrieve details about a team member.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamidmembersaccountid/get-team-member

Source
get_teams

List available teams.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teams/list-teams

Source
get_tempkey(id : Identifier)
Source
headers
Source
headers=(headers : HTTP::Headers)
Source
host
Source
host=(host : String)
Source
http
Source
list_configuration_parameters(id : Identifier)

List configuration parameter values.

Source
list_peerings(network_id)
Source
list_roles(cluster_id)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridroles/list-roles

Source
list_supported_configuration_parameters

List support configuration parameters

Source
list_team_members(team_id)

List the memebers of a team.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamidmembers/list-team-members

Source
patch(path, body)
Source
post(path, body = nil)
Source
put(path, body = nil)
Source
remove_team_member(team_id, account_id)

Remove a team member from a team.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamidmembersaccountid/remove-team-member

Source
restart_cluster(id, service : String)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrestart/restart-cluster

Source
resume_cluster(id : Identifier)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionsresume/resume-cluster

Source
suspend_cluster(id : Identifier)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridactionssuspend/suspend-cluster

Source
update_cluster(cluster_id, body)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusterid/update-cluster

Source
update_configuration_parameters(id, parameters, allow_restart : Bool = false)

Update configuration parameter values.

Source
update_firewall_rule(network_id, firewall_rule_id, params : FirewallRuleUpdateParams)

Update a firewall rule for a network.

https://docs.crunchybridge.com/api/network-firewall-rule#update-firewall-rule

Source
update_log_destination(cluster_id, logdest_id, ld)

Update an existing logger on a cluster.

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridloggersloggerid/update-logger

Source
update_role(cluster_id, role_name, ur)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridrolesrolename/update-role

Source
update_team(id, options)

Update a team.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamid/update-team

Source
update_team_member(team_id, account_id, role)

Update a team member.

https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamidmembersaccountid/update-team-member

Source
update_upgrade_cluster(uc)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridupgrade/update-upgrade-cluster

Source
upgrade_cluster(uc)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridupgrade/upgrade-cluster

Source
upgrade_cluster_cancel(id)
Source
upgrade_cluster_status(id)

https://crunchybridgeapi.docs.apiary.io/#reference/0/clustersclusteridupgrade/get-upgrade-status

Source

Nested types