IAM Reference: Operations and Resources

Tagged in

dns

list-dns-domain-records

GET /dns-domain/<domain-id>/record

List DNS domain records

Parameters:

parameters.domain_id

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at

delete-dns-domain

DELETE /dns-domain/<id>

Delete DNS Domain

Parameters:

parameters.id

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at

get-dns-domain-record

GET /dns-domain/<domain-id>/record/<record-id>

Retrieve DNS domain record details

Parameters:

parameters.record_id
parameters.domain_id

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at
resources.dns_domain_record.priority
resources.dns_domain_record.id
resources.dns_domain_record.name
resources.dns_domain_record.updated_at
resources.dns_domain_record.content
resources.dns_domain_record.type
resources.dns_domain_record.ttl
resources.dns_domain_record.created_at

get-dns-domain

GET /dns-domain/<id>

Retrieve DNS domain details

Parameters:

parameters.id

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at

get-dns-domain-zone-file

GET /dns-domain/<id>/zone

Retrieve DNS domain zone file

Parameters:

parameters.id

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at

list-dns-domains

GET /dns-domain

List DNS domains

create-dns-domain

POST /dns-domain

Create DNS domain

Parameters:

parameters.unicode_name

update-dns-domain-record

PUT /dns-domain/<domain-id>/record/<record-id>

Update DNS domain record

Parameters:

parameters.priority
parameters.name
parameters.content
parameters.record_id
parameters.domain_id
parameters.ttl

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at
resources.dns_domain_record.priority
resources.dns_domain_record.id
resources.dns_domain_record.name
resources.dns_domain_record.updated_at
resources.dns_domain_record.content
resources.dns_domain_record.type
resources.dns_domain_record.ttl
resources.dns_domain_record.created_at

create-dns-domain-record

POST /dns-domain/<domain-id>/record

Create DNS domain record

Parameters:

parameters.priority
parameters.name
parameters.content
parameters.type
parameters.domain_id
parameters.ttl

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at

delete-dns-domain-record

DELETE /dns-domain/<domain-id>/record/<record-id>

Delete DNS domain record

Parameters:

parameters.record_id
parameters.domain_id

Resources:

resources.dns_domain.id
resources.dns_domain.unicode_name
resources.dns_domain.created_at
resources.dns_domain_record.priority
resources.dns_domain_record.id
resources.dns_domain_record.name
resources.dns_domain_record.updated_at
resources.dns_domain_record.content
resources.dns_domain_record.type
resources.dns_domain_record.ttl
resources.dns_domain_record.created_at

compute

delete-instance-pool

DELETE /instance-pool/<id>

Delete an Instance Pool

Parameters:

parameters.id

Resources:

resources.instance_pool.id
resources.instance_pool.name
resources.instance_pool.labels
resources.instance_pool.description

attach-instance-to-elastic-ip

PUT /elastic-ip/<id>:attach

Attach a Compute instance to an Elastic IP

Parameters:

parameters.id
parameters.instance

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

detach-instance-from-elastic-ip

PUT /elastic-ip/<id>:detach

Detach a Compute instance from an Elastic IP

Parameters:

parameters.id
parameters.instance

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

create-load-balancer

POST /load-balancer

Create a Load Balancer

Parameters:

parameters.name
parameters.labels
parameters.description

list-ssh-keys

GET /ssh-key

List SSH keys

get-deploy-target

GET /deploy-target/<id>

Retrieve Deploy Target details

Parameters:

parameters.id

Resources:

resources.deploy_target.id
resources.deploy_target.name
resources.deploy_target.type
resources.deploy_target.description

reset-instance-field

DELETE /instance/<id>/<field>

Reset Instance field

Parameters:

parameters.id
parameters.field

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

create-elastic-ip

POST /elastic-ip

Create an Elastic IP

Parameters:

parameters.labels
parameters.healthcheck
parameters.addressfamily
parameters.description

delete-template

DELETE /template/<id>

Delete a Template

Parameters:

parameters.id

Resources:

resources.template.zones
resources.template.url
resources.template.default_user
resources.template.ssh_key_enabled
resources.template.id
resources.template.visibility
resources.template.name
resources.template.build
resources.template.family
resources.template.version
resources.template.maintainer
resources.template.created_at
resources.template.size
resources.template.checksum
resources.template.password_enabled
resources.template.description
resources.template.boot_mode

get-instance-pool

GET /instance-pool/<id>

Retrieve Instance Pool details

Parameters:

parameters.id

Resources:

resources.instance_pool.id
resources.instance_pool.name
resources.instance_pool.labels
resources.instance_pool.description

remove-external-source-from-security-group

PUT /security-group/<id>:remove-source

Remove an external source from a Security Group

Parameters:

parameters.cidr
parameters.id

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description

resize-instance-disk

PUT /instance/<id>:resize-disk

Resize a Compute instance disk

Parameters:

parameters.id
parameters.disk_size

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

attach-instance-to-private-network

PUT /private-network/<id>:attach

Attach a Compute instance to a Private Network

Parameters:

parameters.id
parameters.ip
parameters.instance

Resources:

resources.private_network.id
resources.private_network.netmask
resources.private_network.name
resources.private_network.start_ip
resources.private_network.leases
resources.private_network.labels
resources.private_network.description
resources.private_network.end_ip

create-sks-cluster

POST /sks-cluster

Create an SKS cluster

Parameters:

parameters.addons
parameters.cni
parameters.name
parameters.level
parameters.labels
parameters.version
parameters.auto_upgrade
parameters.oidc
parameters.description

reset-sks-cluster-field

DELETE /sks-cluster/<id>/<field>

Reset an SKS cluster field to its default value

Parameters:

parameters.id
parameters.field

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

reset-load-balancer-service-field

DELETE /load-balancer/<id>/service/<service-id>/<field>

Reset a Load Balancer Service field to its default value

Parameters:

parameters.service_id
parameters.id
parameters.field

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

copy-template

POST /template/<id>

Copy a Template from a zone to another

Parameters:

parameters.target_zone
parameters.id

Resources:

resources.template.zones
resources.template.url
resources.template.default_user
resources.template.ssh_key_enabled
resources.template.id
resources.template.visibility
resources.template.name
resources.template.build
resources.template.family
resources.template.version
resources.template.maintainer
resources.template.created_at
resources.template.size
resources.template.checksum
resources.template.password_enabled
resources.template.description
resources.template.boot_mode

delete-load-balancer-service

DELETE /load-balancer/<id>/service/<service-id>

Delete a Load Balancer Service

Parameters:

parameters.service_id
parameters.id

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

delete-sks-cluster

DELETE /sks-cluster/<id>

Delete an SKS cluster

Parameters:

parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

update-instance-pool

PUT /instance-pool/<id>

Update an Instance Pool

Parameters:

parameters.ssh_keys
parameters.private_networks
parameters.instance_prefix
parameters.ipv6_enabled
parameters.min_available
parameters.public_ip_assignment
parameters.id
parameters.name
parameters.elastic_ips
parameters.labels
parameters.ssh_key
parameters.anti_affinity_groups
parameters.disk_size
parameters.instance_type
parameters.deploy_target
parameters.template
parameters.user_data
parameters.security_groups
parameters.description

Resources:

resources.instance_pool.id
resources.instance_pool.name
resources.instance_pool.labels
resources.instance_pool.description

list-quotas

GET /quota

List Organization Quotas

start-instance

PUT /instance/<id>:start

Start a Compute instance

Parameters:

parameters.rescue_profile
parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

revert-instance-to-snapshot

POST /instance/<instance-id>:revert-snapshot

Revert a snapshot for an instance

Parameters:

parameters.id
parameters.instance_id

Resources:

resources.snapshot.id
resources.snapshot.name
resources.snapshot.instance
resources.snapshot.created_at
resources.snapshot.size
resources.snapshot.description
resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

list-events

GET /event

List Events

Parameters:

parameters.from
parameters.to

create-security-group

POST /security-group

Create a Security Group

Parameters:

parameters.name
parameters.description

reset-private-network-field

DELETE /private-network/<id>/<field>

Reset Private Network field

Parameters:

parameters.id
parameters.field

Resources:

resources.private_network.id
resources.private_network.netmask
resources.private_network.name
resources.private_network.start_ip
resources.private_network.leases
resources.private_network.labels
resources.private_network.description
resources.private_network.end_ip

add-instance-protection

PUT /instance/<id>:add-protection

Set instance destruction protection

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

list-instance-types

GET /instance-type

List Compute instance Types

list-templates

GET /template

List Templates

Parameters:

parameters.visibility
parameters.family

promote-snapshot-to-template

POST /snapshot/<id>:promote

Promote a Snapshot to a Template

Parameters:

parameters.default_user
parameters.ssh_key_enabled
parameters.id
parameters.name
parameters.password_enabled
parameters.description

Resources:

resources.snapshot.id
resources.snapshot.name
resources.snapshot.instance
resources.snapshot.created_at
resources.snapshot.size
resources.snapshot.description

get-sks-cluster

GET /sks-cluster/<id>

Retrieve SKS cluster details

Parameters:

parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

get-sks-cluster-inspection

GET /sks-cluster/<id>/inspection

Retrieve the most recent SKS cluster inspection

Parameters:

parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

update-template

PUT /template/<id>

Update template attributes

Parameters:

parameters.id
parameters.name
parameters.description

Resources:

resources.template.zones
resources.template.url
resources.template.default_user
resources.template.ssh_key_enabled
resources.template.id
resources.template.visibility
resources.template.name
resources.template.build
resources.template.family
resources.template.version
resources.template.maintainer
resources.template.created_at
resources.template.size
resources.template.checksum
resources.template.password_enabled
resources.template.description
resources.template.boot_mode

scale-instance-pool

PUT /instance-pool/<id>:scale

Scale an Instance Pool

Parameters:

parameters.id
parameters.size

Resources:

resources.instance_pool.id
resources.instance_pool.name
resources.instance_pool.labels
resources.instance_pool.description

list-security-groups

GET /security-group

List Security Groups.

Parameters:

parameters.visibility

list-sks-cluster-versions

GET /sks-cluster-version

List available versions for SKS clusters

Parameters:

parameters.include_deprecated

update-reverse-dns-instance

POST /reverse-dns/instance/<id>

Update/Create the PTR DNS record for an instance

Parameters:

parameters.domain_name
parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

create-instance

POST /instance

Create a Compute instance

Parameters:

parameters.ssh_keys
parameters.ipv6_enabled
parameters.public_ip_assignment
parameters.name
parameters.labels
parameters.ssh_key
parameters.anti_affinity_groups
parameters.disk_size
parameters.instance_type
parameters.deploy_target
parameters.template
parameters.auto_start
parameters.user_data
parameters.security_groups

delete-snapshot

DELETE /snapshot/<id>

Delete a Snapshot

Parameters:

parameters.id

Resources:

resources.snapshot.id
resources.snapshot.name
resources.snapshot.instance
resources.snapshot.created_at
resources.snapshot.size
resources.snapshot.description

list-instance-pools

GET /instance-pool

List Instance Pools

delete-ssh-key

DELETE /ssh-key/<name>

Delete a SSH key

Parameters:

parameters.name

Resources:

resources.ssh_key.name

update-load-balancer

PUT /load-balancer/<id>

Update a Load Balancer

Parameters:

parameters.id
parameters.name
parameters.labels
parameters.description

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

detach-instance-from-security-group

PUT /security-group/<id>:detach

Detach a Compute instance from a Security Group

Parameters:

parameters.id
parameters.instance

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description

delete-load-balancer

DELETE /load-balancer/<id>

Delete a Load Balancer

Parameters:

parameters.id

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

list-zones

GET /zone

List Zones

evict-sks-nodepool-members

PUT /sks-cluster/<id>/nodepool/<sks-nodepool-id>:evict

Evict Nodepool members

Parameters:

parameters.id
parameters.sks_nodepool_id
parameters.instances

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description
resources.sks_nodepool.private_networks
resources.sks_nodepool.instance_prefix
resources.sks_nodepool.addons
resources.sks_nodepool.id
resources.sks_nodepool.kubelet_image_gc
resources.sks_nodepool.name
resources.sks_nodepool.labels
resources.sks_nodepool.taints
resources.sks_nodepool.anti_affinity_groups
resources.sks_nodepool.disk_size
resources.sks_nodepool.instance_type
resources.sks_nodepool.deploy_target
resources.sks_nodepool.instance_pool
resources.sks_nodepool.template
resources.sks_nodepool.state
resources.sks_nodepool.version
resources.sks_nodepool.created_at
resources.sks_nodepool.size
resources.sks_nodepool.security_groups
resources.sks_nodepool.description

reset-instance

PUT /instance/<id>:reset

Reset a Compute instance to a base/target template

Parameters:

parameters.id
parameters.disk_size
parameters.template

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

rotate-sks-ccm-credentials

PUT /sks-cluster/<id>/rotate-ccm-credentials

Rotate Exoscale CCM credentials

Parameters:

parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

get-security-group

GET /security-group/<id>

Retrieve Security Group details

Parameters:

parameters.id

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description

attach-instance-to-security-group

PUT /security-group/<id>:attach

Attach a Compute instance to a Security Group

Parameters:

parameters.id
parameters.instance

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description

update-load-balancer-service

PUT /load-balancer/<id>/service/<service-id>

Update a Load Balancer Service

Parameters:

parameters.protocol
parameters.strategy
parameters.service_id
parameters.id
parameters.name
parameters.healthcheck
parameters.port
parameters.target_port
parameters.description

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

remove-instance-protection

PUT /instance/<id>:remove-protection

Remove instance destruction protection

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

update-sks-nodepool

PUT /sks-cluster/<id>/nodepool/<sks-nodepool-id>

Update an SKS Nodepool

Parameters:

parameters.private_networks
parameters.instance_prefix
parameters.id
parameters.name
parameters.labels
parameters.sks_nodepool_id
parameters.taints
parameters.anti_affinity_groups
parameters.disk_size
parameters.instance_type
parameters.deploy_target
parameters.security_groups
parameters.description

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description
resources.sks_nodepool.private_networks
resources.sks_nodepool.instance_prefix
resources.sks_nodepool.addons
resources.sks_nodepool.id
resources.sks_nodepool.kubelet_image_gc
resources.sks_nodepool.name
resources.sks_nodepool.labels
resources.sks_nodepool.taints
resources.sks_nodepool.anti_affinity_groups
resources.sks_nodepool.disk_size
resources.sks_nodepool.instance_type
resources.sks_nodepool.deploy_target
resources.sks_nodepool.instance_pool
resources.sks_nodepool.template
resources.sks_nodepool.state
resources.sks_nodepool.version
resources.sks_nodepool.created_at
resources.sks_nodepool.size
resources.sks_nodepool.security_groups
resources.sks_nodepool.description

update-elastic-ip

PUT /elastic-ip/<id>

Update an Elastic IP

Parameters:

parameters.id
parameters.labels
parameters.healthcheck
parameters.description

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

get-anti-affinity-group

GET /anti-affinity-group/<id>

Retrieve Anti-affinity Group details

Parameters:

parameters.id

Resources:

resources.anti_affinity_group.id
resources.anti_affinity_group.name
resources.anti_affinity_group.instances
resources.anti_affinity_group.description

upgrade-sks-cluster-service-level

PUT /sks-cluster/<id>/upgrade-service-level

Upgrade a SKS cluster to pro

Parameters:

parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

reset-load-balancer-field

DELETE /load-balancer/<id>/<field>

Reset a Load Balancer field to its default value

Parameters:

parameters.id
parameters.field

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

get-ssh-key

GET /ssh-key/<name>

Retrieve SSH key details

Parameters:

parameters.name

Resources:

resources.ssh_key.name

get-quota

GET /quota/<entity>

Retrieve Resource Quota

Parameters:

parameters.entity

get-reverse-dns-instance

GET /reverse-dns/instance/<id>

Query the PTR DNS records for an instance

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

update-private-network-instance-ip

PUT /private-network/<id>:update-ip

Update the IP address of an instance attached to a managed private network

Parameters:

parameters.id
parameters.ip
parameters.instance

Resources:

resources.private_network.id
resources.private_network.netmask
resources.private_network.name
resources.private_network.start_ip
resources.private_network.leases
resources.private_network.labels
resources.private_network.description
resources.private_network.end_ip

reset-elastic-ip-field

DELETE /elastic-ip/<id>/<field>

Reset an Elastic IP field to its default value

Parameters:

parameters.id
parameters.field

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

reboot-instance

PUT /instance/<id>:reboot

Reboot a Compute instance

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

delete-instance

DELETE /instance/<id>

Delete a Compute instance

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

list-deploy-targets

GET /deploy-target

List Deploy Targets

get-sks-cluster-authority-cert

GET /sks-cluster/<id>/authority/<authority>/cert

Get the certificate for a SKS cluster authority

Parameters:

parameters.authority
parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

get-template

GET /template/<id>

Retrieve Template details

Parameters:

parameters.id

Resources:

resources.template.zones
resources.template.url
resources.template.default_user
resources.template.ssh_key_enabled
resources.template.id
resources.template.visibility
resources.template.name
resources.template.build
resources.template.family
resources.template.version
resources.template.maintainer
resources.template.created_at
resources.template.size
resources.template.checksum
resources.template.password_enabled
resources.template.description
resources.template.boot_mode

delete-reverse-dns-instance

DELETE /reverse-dns/instance/<id>

Delete the PTR DNS record for an instance

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

add-rule-to-security-group

POST /security-group/<id>/rules

Create a Security Group rule

Parameters:

parameters.protocol
parameters.end_port
parameters.flow_direction
parameters.icmp
parameters.id
parameters.network
parameters.start_port
parameters.security_group
parameters.description

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description

generate-sks-cluster-kubeconfig

POST /sks-cluster-kubeconfig/<id>

Generate a new Kubeconfig file for a SKS cluster

Parameters:

parameters.user
parameters.id
parameters.ttl
parameters.groups

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

get-load-balancer-service

GET /load-balancer/<id>/service/<service-id>

Retrieve Load Balancer Service details

Parameters:

parameters.service_id
parameters.id

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

list-instances

GET /instance

List Compute instances

Parameters:

parameters.manager_type
parameters.manager_id
parameters.ip_address

reveal-instance-password

GET /instance/<id>:password

Reveal the password used during instance creation or the latest password reset.

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

add-external-source-to-security-group

PUT /security-group/<id>:add-source

Add an external source as a member of a Security Group

Parameters:

parameters.cidr
parameters.id

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description

update-sks-cluster

PUT /sks-cluster/<id>

Update an SKS cluster

Parameters:

parameters.addons
parameters.id
parameters.name
parameters.labels
parameters.auto_upgrade
parameters.description

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

list-sks-cluster-deprecated-resources

GET /sks-cluster-deprecated-resources/<id>

Resources that are scheduled to be removed in future kubernetes releases

Parameters:

parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

update-private-network

PUT /private-network/<id>

Update a Private Network

Parameters:

parameters.id
parameters.netmask
parameters.name
parameters.start_ip
parameters.labels
parameters.description
parameters.end_ip

Resources:

resources.private_network.id
resources.private_network.netmask
resources.private_network.name
resources.private_network.start_ip
resources.private_network.leases
resources.private_network.labels
resources.private_network.description
resources.private_network.end_ip

update-instance

PUT /instance/<id>

Update a Compute instance

Parameters:

parameters.public_ip_assignment
parameters.id
parameters.name
parameters.labels
parameters.user_data

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

create-instance-pool

POST /instance-pool

Create an Instance Pool

Parameters:

parameters.ssh_keys
parameters.private_networks
parameters.instance_prefix
parameters.ipv6_enabled
parameters.min_available
parameters.public_ip_assignment
parameters.name
parameters.elastic_ips
parameters.labels
parameters.ssh_key
parameters.anti_affinity_groups
parameters.disk_size
parameters.instance_type
parameters.deploy_target
parameters.template
parameters.size
parameters.user_data
parameters.security_groups
parameters.description

detach-instance-from-private-network

PUT /private-network/<id>:detach

Detach a Compute instance from a Private Network

Parameters:

parameters.id
parameters.instance

Resources:

resources.private_network.id
resources.private_network.netmask
resources.private_network.name
resources.private_network.start_ip
resources.private_network.leases
resources.private_network.labels
resources.private_network.description
resources.private_network.end_ip

get-elastic-ip

GET /elastic-ip/<id>

Retrieve Elastic IP details

Parameters:

parameters.id

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

list-anti-affinity-groups

GET /anti-affinity-group

List Anti-affinity Groups

delete-anti-affinity-group

DELETE /anti-affinity-group/<id>

Delete an Anti-affinity Group

Parameters:

parameters.id

Resources:

resources.anti_affinity_group.id
resources.anti_affinity_group.name
resources.anti_affinity_group.instances
resources.anti_affinity_group.description

create-anti-affinity-group

POST /anti-affinity-group

Create an Anti-affinity Group

Parameters:

parameters.name
parameters.description

get-private-network

GET /private-network/<id>

Retrieve Private Network details

Parameters:

parameters.id

Resources:

resources.private_network.id
resources.private_network.netmask
resources.private_network.name
resources.private_network.start_ip
resources.private_network.leases
resources.private_network.labels
resources.private_network.description
resources.private_network.end_ip

scale-instance

PUT /instance/<id>:scale

Scale a Compute instance to a new Instance Type

Parameters:

parameters.id
parameters.instance_type

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

get-instance-type

GET /instance-type/<id>

Retrieve Instance Type details

Parameters:

parameters.id

Resources:

resources.instance_type.zones
resources.instance_type.gpus
resources.instance_type.authorized
resources.instance_type.id
resources.instance_type.memory
resources.instance_type.family
resources.instance_type.size
resources.instance_type.cpus

register-template

POST /template

Parameters:

parameters.url
parameters.default_user
parameters.ssh_key_enabled
parameters.name
parameters.build
parameters.version
parameters.maintainer
parameters.size
parameters.checksum
parameters.password_enabled
parameters.description
parameters.boot_mode

get-snapshot

GET /snapshot/<id>

Retrieve Snapshot details

Parameters:

parameters.id

Resources:

resources.snapshot.id
resources.snapshot.name
resources.snapshot.instance
resources.snapshot.created_at
resources.snapshot.size
resources.snapshot.description

get-sks-nodepool

GET /sks-cluster/<id>/nodepool/<sks-nodepool-id>

Retrieve SKS Nodepool details

Parameters:

parameters.id
parameters.sks_nodepool_id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description
resources.sks_nodepool.private_networks
resources.sks_nodepool.instance_prefix
resources.sks_nodepool.addons
resources.sks_nodepool.id
resources.sks_nodepool.kubelet_image_gc
resources.sks_nodepool.name
resources.sks_nodepool.labels
resources.sks_nodepool.taints
resources.sks_nodepool.anti_affinity_groups
resources.sks_nodepool.disk_size
resources.sks_nodepool.instance_type
resources.sks_nodepool.deploy_target
resources.sks_nodepool.instance_pool
resources.sks_nodepool.template
resources.sks_nodepool.state
resources.sks_nodepool.version
resources.sks_nodepool.created_at
resources.sks_nodepool.size
resources.sks_nodepool.security_groups
resources.sks_nodepool.description

delete-private-network

DELETE /private-network/<id>

Delete a Private Network

Parameters:

parameters.id

Resources:

resources.private_network.id
resources.private_network.netmask
resources.private_network.name
resources.private_network.start_ip
resources.private_network.leases
resources.private_network.labels
resources.private_network.description
resources.private_network.end_ip

delete-sks-nodepool

DELETE /sks-cluster/<id>/nodepool/<sks-nodepool-id>

Delete an SKS Nodepool

Parameters:

parameters.id
parameters.sks_nodepool_id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description
resources.sks_nodepool.private_networks
resources.sks_nodepool.instance_prefix
resources.sks_nodepool.addons
resources.sks_nodepool.id
resources.sks_nodepool.kubelet_image_gc
resources.sks_nodepool.name
resources.sks_nodepool.labels
resources.sks_nodepool.taints
resources.sks_nodepool.anti_affinity_groups
resources.sks_nodepool.disk_size
resources.sks_nodepool.instance_type
resources.sks_nodepool.deploy_target
resources.sks_nodepool.instance_pool
resources.sks_nodepool.template
resources.sks_nodepool.state
resources.sks_nodepool.version
resources.sks_nodepool.created_at
resources.sks_nodepool.size
resources.sks_nodepool.security_groups
resources.sks_nodepool.description

get-reverse-dns-elastic-ip

GET /reverse-dns/elastic-ip/<id>

Query the PTR DNS records for an elastic IP

Parameters:

parameters.id

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

scale-sks-nodepool

PUT /sks-cluster/<id>/nodepool/<sks-nodepool-id>:scale

Scale a SKS Nodepool

Parameters:

parameters.id
parameters.sks_nodepool_id
parameters.size

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description
resources.sks_nodepool.private_networks
resources.sks_nodepool.instance_prefix
resources.sks_nodepool.addons
resources.sks_nodepool.id
resources.sks_nodepool.kubelet_image_gc
resources.sks_nodepool.name
resources.sks_nodepool.labels
resources.sks_nodepool.taints
resources.sks_nodepool.anti_affinity_groups
resources.sks_nodepool.disk_size
resources.sks_nodepool.instance_type
resources.sks_nodepool.deploy_target
resources.sks_nodepool.instance_pool
resources.sks_nodepool.template
resources.sks_nodepool.state
resources.sks_nodepool.version
resources.sks_nodepool.created_at
resources.sks_nodepool.size
resources.sks_nodepool.security_groups
resources.sks_nodepool.description

delete-elastic-ip

DELETE /elastic-ip/<id>

Delete an Elastic IP

Parameters:

parameters.id

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

get-load-balancer

GET /load-balancer/<id>

Retrieve Load Balancer details

Parameters:

parameters.id

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

list-private-networks

GET /private-network

List Private Networks

upgrade-sks-cluster

PUT /sks-cluster/<id>/upgrade

Upgrade an SKS cluster

Parameters:

parameters.id
parameters.version

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

update-reverse-dns-elastic-ip

POST /reverse-dns/elastic-ip/<id>

Update/Create the PTR DNS record for an elastic IP

Parameters:

parameters.domain_name
parameters.id

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

list-sks-clusters

GET /sks-cluster

List SKS clusters

delete-reverse-dns-elastic-ip

DELETE /reverse-dns/elastic-ip/<id>

Delete the PTR DNS record for an elastic IP

Parameters:

parameters.id

Resources:

resources.elastic_ip.cidr
resources.elastic_ip.id
resources.elastic_ip.labels
resources.elastic_ip.ip
resources.elastic_ip.healthcheck
resources.elastic_ip.addressfamily
resources.elastic_ip.description

list-elastic-ips

GET /elastic-ip

List Elastic IPs

register-ssh-key

POST /ssh-key

Import SSH key

Parameters:

parameters.public_key
parameters.name

reset-instance-pool-field

DELETE /instance-pool/<id>/<field>

Reset an Instance Pool field to its default value

Parameters:

parameters.id
parameters.field

Resources:

resources.instance_pool.id
resources.instance_pool.name
resources.instance_pool.labels
resources.instance_pool.description

reset-sks-nodepool-field

DELETE /sks-cluster/<id>/nodepool/<sks-nodepool-id>/<field>

Reset an SKS Nodepool field to its default value

Parameters:

parameters.id
parameters.sks_nodepool_id
parameters.field

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description
resources.sks_nodepool.private_networks
resources.sks_nodepool.instance_prefix
resources.sks_nodepool.addons
resources.sks_nodepool.id
resources.sks_nodepool.kubelet_image_gc
resources.sks_nodepool.name
resources.sks_nodepool.labels
resources.sks_nodepool.taints
resources.sks_nodepool.anti_affinity_groups
resources.sks_nodepool.disk_size
resources.sks_nodepool.instance_type
resources.sks_nodepool.deploy_target
resources.sks_nodepool.instance_pool
resources.sks_nodepool.template
resources.sks_nodepool.state
resources.sks_nodepool.version
resources.sks_nodepool.created_at
resources.sks_nodepool.size
resources.sks_nodepool.security_groups
resources.sks_nodepool.description

delete-security-group

DELETE /security-group/<id>

Delete a Security Group

Parameters:

parameters.id

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description

create-private-network

POST /private-network

Create a Private Network

Parameters:

parameters.netmask
parameters.name
parameters.start_ip
parameters.labels
parameters.description
parameters.end_ip

list-load-balancers

GET /load-balancer

List Load Balancers

list-snapshots

GET /snapshot

List Snapshots

create-snapshot

POST /instance/<id>:create-snapshot

Create a Snapshot of a Compute instance

Parameters:

parameters.id

Resources:

resources.instance.id
resources.instance.name
resources.instance.labels
resources.instance.created_at

evict-instance-pool-members

PUT /instance-pool/<id>:evict

Evict Instance Pool members

Parameters:

parameters.id
parameters.instances

Resources:

resources.instance_pool.id
resources.instance_pool.name
resources.instance_pool.labels
resources.instance_pool.description

add-service-to-load-balancer

POST /load-balancer/<id>/service

Add a Load Balancer Service

Parameters:

parameters.protocol
parameters.strategy
parameters.id
parameters.name
parameters.healthcheck
parameters.port
parameters.instance_pool
parameters.target_port
parameters.description

Resources:

resources.load_balancer.services
resources.load_balancer.id
resources.load_balancer.name
resources.load_balancer.labels
resources.load_balancer.ip
resources.load_balancer.state
resources.load_balancer.created_at
resources.load_balancer.description

delete-rule-from-security-group

DELETE /security-group/<id>/rules/<rule-id>

Delete a Security Group rule

Parameters:

parameters.id
parameters.rule_id

Resources:

resources.security_group.external_sources
resources.security_group.id
resources.security_group.name
resources.security_group.rules
resources.security_group.description
resources.security_group_rule.protocol
resources.security_group_rule.end_port
resources.security_group_rule.flow_direction
resources.security_group_rule.icmp
resources.security_group_rule.id
resources.security_group_rule.network
resources.security_group_rule.start_port
resources.security_group_rule.security_group
resources.security_group_rule.description

export-snapshot

POST /snapshot/<id>:export

Export a Snapshot

Parameters:

parameters.id

Resources:

resources.snapshot.id
resources.snapshot.name
resources.snapshot.instance
resources.snapshot.created_at
resources.snapshot.size
resources.snapshot.description

rotate-sks-operators-ca

PUT /sks-cluster/<id>/rotate-operators-ca

Rotate operators certificate authority

Parameters:

parameters.id

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

get-instance

GET /instance/<id>

Retrieve Compute instance details

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

create-sks-nodepool

POST /sks-cluster/<id>/nodepool

Create a new SKS Nodepool

Parameters:

parameters.private_networks
parameters.instance_prefix
parameters.addons
parameters.id
parameters.kubelet_image_gc
parameters.name
parameters.labels
parameters.taints
parameters.anti_affinity_groups
parameters.disk_size
parameters.instance_type
parameters.deploy_target
parameters.size
parameters.security_groups
parameters.description

Resources:

resources.sks_cluster.addons
resources.sks_cluster.nodepools
resources.sks_cluster.id
resources.sks_cluster.cni
resources.sks_cluster.name
resources.sks_cluster.level
resources.sks_cluster.labels
resources.sks_cluster.state
resources.sks_cluster.version
resources.sks_cluster.created_at
resources.sks_cluster.endpoint
resources.sks_cluster.auto_upgrade
resources.sks_cluster.description

stop-instance

PUT /instance/<id>:stop

Stop a Compute instance

Parameters:

parameters.id

Resources:

resources.instance.ssh_keys
resources.instance.private_networks
resources.instance.public_ip_assignment
resources.instance.id
resources.instance.ipv6_address
resources.instance.name
resources.instance.elastic_ips
resources.instance.labels
resources.instance.public_ip
resources.instance.ssh_key
resources.instance.anti_affinity_groups
resources.instance.disk_size
resources.instance.instance_type
resources.instance.deploy_target
resources.instance.template
resources.instance.state
resources.instance.snapshots
resources.instance.created_at
resources.instance.manager
resources.instance.user_data
resources.instance.security_groups

attach-block-storage-volume-to-instance

PUT /block-storage/<id>:attach

Parameters:

parameters.id
parameters.instance.id

Resources:

resources.instance.id
resources.instance.name
resources.instance.created_at
resources.instance.state
resources.instance.instance_type
resources.instance.template
resources.instance.disk_size
resources.instance.ssh_key
resources.instance.ssh_keys
resources.instance.user_data
resources.instance.elastic_ips
resources.instance.manager
resources.instance.public_ip
resources.instance.ipv6_address
resources.instance.public_ip_assignment
resources.instance.security_groups
resources.instance.anti_affinity_groups
resources.instance.private_networks
resources.instance.snapshots
resources.instance.labels
resources.instance.deploy_target
resources.block_storage_volume.id
resources.block_storage_volume.name
resources.block_storage_volume.created_at
resources.block_storage_volume.state
resources.block_storage_volume.size
resources.block_storage_volume.blocksize
resources.block_storage_volume.instance
resources.block_storage_volume.block_storage_snapshots

get-block-storage-snapshot

GET /block-storage-snapshot/<id>

Parameters:

parameters.id

Resources:

resources.block_storage_snapshot.id
resources.block_storage_snapshot.name
resources.block_storage_snapshot.created_at
resources.block_storage_snapshot.state
resources.block_storage_snapshot.size
resources.block_storage_snapshot.block_storage_volume

update-block-storage-snapshot

PUT /block-storage-snapshot/<id>

Parameters:

parameters.id
parameters.name
parameters.labels

Resources:

resources.block_storage_snapshot.id
resources.block_storage_snapshot.name
resources.block_storage_snapshot.created_at
resources.block_storage_snapshot.state
resources.block_storage_snapshot.size
resources.block_storage_snapshot.block_storage_volume

delete-block-storage-snapshot

DELETE /block-storage-snapshot/<id>

Parameters:

parameters.id

Resources:

resources.block_storage_snapshot.id
resources.block_storage_snapshot.name
resources.block_storage_snapshot.created_at
resources.block_storage_snapshot.state
resources.block_storage_snapshot.size
resources.block_storage_snapshot.block_storage_volume

get-block-storage-volume

GET /block-storage/<id>

Parameters:

parameters.id

Resources:

resources.block_storage_volume.id
resources.block_storage_volume.name
resources.block_storage_volume.created_at
resources.block_storage_volume.state
resources.block_storage_volume.size
resources.block_storage_volume.blocksize
resources.block_storage_volume.instance
resources.block_storage_volume.block_storage_snapshots

update-block-storage-volume

PUT /block-storage/<id>

Parameters:

parameters.id
parameters.name
parameters.labels

Resources:

resources.block_storage_volume.id
resources.block_storage_volume.name
resources.block_storage_volume.created_at
resources.block_storage_volume.state
resources.block_storage_volume.size
resources.block_storage_volume.blocksize
resources.block_storage_volume.instance
resources.block_storage_volume.block_storage_snapshots

delete-block-storage-volume

DELETE /block-storage/<id>

Parameters:

parameters.id

Resources:

resources.block_storage_volume.id
resources.block_storage_volume.name
resources.block_storage_volume.created_at
resources.block_storage_volume.state
resources.block_storage_volume.size
resources.block_storage_volume.blocksize
resources.block_storage_volume.instance
resources.block_storage_volume.block_storage_snapshots

create-block-storage-snapshot

POST /block-storage/<id>:create-snapshot

Parameters:

parameters.id
parameters.name
parameters.labels

Resources:

resources.block_storage_volume.id
resources.block_storage_volume.name
resources.block_storage_volume.created_at
resources.block_storage_volume.state
resources.block_storage_volume.size
resources.block_storage_volume.blocksize
resources.block_storage_volume.instance
resources.block_storage_volume.block_storage_snapshots

Parameters:

parameters.id
parameters.size

Resources:

resources.block_storage_volume.id
resources.block_storage_volume.name
resources.block_storage_volume.created_at
resources.block_storage_volume.state
resources.block_storage_volume.size
resources.block_storage_volume.blocksize
resources.block_storage_volume.instance
resources.block_storage_volume.block_storage_snapshots

detach-block-storage-volume

PUT /block-storage/<id>:detach

Parameters:

parameters.id

Resources:

resources.block_storage_volume.id
resources.block_storage_volume.name
resources.block_storage_volume.created_at
resources.block_storage_volume.state
resources.block_storage_volume.size
resources.block_storage_volume.blocksize
resources.block_storage_volume.instance
resources.block_storage_volume.block_storage_snapshots

create-block-storage-volume

POST /block-storage

Parameters:

parameters.name
parameters.size
parameters.labels
parameters.block_storage_snapshot.id

Resources:

resources.block_storage_snapshot.id
resources.block_storage_snapshot.name
resources.block_storage_snapshot.created_at
resources.block_storage_snapshot.state
resources.block_storage_snapshot.size
resources.block_storage_snapshot.block_storage_volume

dbaas

get-dbaas-settings-pg

GET /dbaas-settings-pg

Get DBaaS PostgreSQL settings

update-dbaas-pg-connection-pool

PUT /dbaas-postgres/<service-name>/connection-pool/<connection-pool-name>

Update a DBaaS PostgreSQL connection pool

Parameters:

parameters.username
parameters.mode
parameters.connection_pool_name
parameters.service_name
parameters.size
parameters.database_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-service-kafka

GET /dbaas-kafka/<name>

Get a DBaaS Kafka service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-service

DELETE /dbaas-service/<name>

Delete a DBaaS service

Parameters:

parameters.name

get-dbaas-kafka-acl-config

GET /dbaas-kafka/<name>/acl-config

Get DBaaS kafka ACL configuration

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-service-grafana

DELETE /dbaas-grafana/<name>

Delete a Grafana service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

stop-dbaas-mysql-migration

POST /dbaas-mysql/<name>/migration/stop

Stop a DBaaS MySQL migration

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

update-dbaas-service-mysql

PUT /dbaas-mysql/<name>

Update a DBaaS MySQL service

Parameters:

parameters.ip_filter
parameters.binlog_retention_period
parameters.backup_schedule
parameters.name
parameters.mysql_settings
parameters.migration
parameters.maintenance
parameters.plan
parameters.termination_protection

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-kafka-topic-acl-config

DELETE /dbaas-kafka/<name>/topic/acl-config/<acl-id>

Delete a Kafka ACL entry

Parameters:

parameters.acl_id
parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

stop-dbaas-redis-migration

POST /dbaas-redis/<name>/migration/stop

Stop a DBaaS Redis migration

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-task

GET /dbaas-task/<service>/<id>

Get a DBaaS task

Parameters:

parameters.id
parameters.service

start-dbaas-kafka-maintenance

PUT /dbaas-kafka/<name>/maintenance/start

Initiate Kafka maintenance update

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

list-dbaas-integration-types

GET /dbaas-integration-types

Get DBaaS integration types

list-dbaas-integration-settings

GET /dbaas-integration-settings/<integration-type>/<source-type>/<dest-type>

Get DBaaS integration settings

Parameters:

parameters.source_type
parameters.dest_type
parameters.integration_type

delete-dbaas-integration

DELETE /dbaas-integration/<id>

Delete a DBaaS Integration

Parameters:

parameters.id

Resources:

resources.dbaas_integration.status
resources.dbaas_integration.description

create-dbaas-task-migration-check

POST /dbaas-task-migration-check/<service>

Parameters:

parameters.method
parameters.ignore_dbs
parameters.source_service_uri
parameters.service

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-kafka-schema-registry-acl-config

DELETE /dbaas-kafka/<name>/schema-registry/acl-config/<acl-id>

Delete a Kafka ACL entry

Parameters:

parameters.acl_id
parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-settings-redis

GET /dbaas-settings-redis

Get DBaaS Redis settings

delete-dbaas-service-redis

DELETE /dbaas-redis/<name>

Delete a Redis service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-service-opensearch

POST /dbaas-opensearch/<name>

Create a DBaaS OpenSearch service

Parameters:

parameters.ip_filter
parameters.keep_index_refresh_interval
parameters.max_index_count
parameters.opensearch_dashboards
parameters.name
parameters.opensearch_settings
parameters.recovery_backup_name
parameters.version
parameters.maintenance
parameters.plan
parameters.index_patterns
parameters.fork_from_service
parameters.index_template
parameters.termination_protection

create-dbaas-service-kafka

POST /dbaas-kafka/<name>

Create a DBaaS Kafka service

Parameters:

parameters.ip_filter
parameters.kafka_rest_settings
parameters.kafka_connect_settings
parameters.kafka_connect_enabled
parameters.kafka_settings
parameters.name
parameters.schema_registry_enabled
parameters.version
parameters.maintenance
parameters.plan
parameters.schema_registry_settings
parameters.termination_protection
parameters.authentication_methods
parameters.kafka_rest_enabled

update-dbaas-service-kafka

PUT /dbaas-kafka/<name>

Update a DBaaS Kafka service

Parameters:

parameters.ip_filter
parameters.kafka_rest_settings
parameters.kafka_connect_settings
parameters.kafka_connect_enabled
parameters.kafka_settings
parameters.name
parameters.schema_registry_enabled
parameters.maintenance
parameters.plan
parameters.schema_registry_settings
parameters.termination_protection
parameters.authentication_methods
parameters.kafka_rest_enabled

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-opensearch-user

DELETE /dbaas-opensearch/<service-name>/user/<username>

Delete a DBaaS OpenSearch user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-kafka-user

DELETE /dbaas-kafka/<service-name>/user/<username>

Delete a DBaaS kafka user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-settings-mysql

GET /dbaas-settings-mysql

Get DBaaS MySQL settings

list-dbaas-service-types

GET /dbaas-service-type

DBaaS Service Types

update-dbaas-service-redis

PUT /dbaas-redis/<name>

Update a DBaaS Redis service

Parameters:

parameters.ip_filter
parameters.redis_settings
parameters.name
parameters.migration
parameters.maintenance
parameters.plan
parameters.termination_protection

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

update-dbaas-service-pg

PUT /dbaas-postgres/<name>

Update a DBaaS PostgreSQL service

Parameters:

parameters.ip_filter
parameters.pglookout_settings
parameters.synchronous_replication
parameters.pg_settings
parameters.backup_schedule
parameters.work_mem
parameters.name
parameters.pgbouncer_settings
parameters.migration
parameters.version
parameters.maintenance
parameters.plan
parameters.termination_protection
parameters.shared_buffers_percentage
parameters.variant
parameters.timescaledb_settings

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-settings-kafka

GET /dbaas-settings-kafka

Get DBaaS Kafka settings

update-dbaas-postgres-allow-replication

PUT /dbaas-postgres/<service-name>/user/<username>/allow-replication

Update access control for one service user

Parameters:

parameters.username
parameters.service_name
parameters.allow_replication

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

update-dbaas-integration

PUT /dbaas-integration/<id>

Update a existing DBaaS integration

Parameters:

parameters.settings
parameters.id

Resources:

resources.dbaas_integration.status
resources.dbaas_integration.description

delete-dbaas-mysql-database

DELETE /dbaas-mysql/<service-name>/database/<database-name>

Delete a DBaaS MySQL database

Parameters:

parameters.service_name
parameters.database_name

get-dbaas-service-grafana

GET /dbaas-grafana/<name>

Get a DBaaS Grafana service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-opensearch-acl-config

GET /dbaas-opensearch/<name>/acl-config

Get DBaaS OpenSearch ACL configuration

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

stop-dbaas-pg-migration

POST /dbaas-postgres/<name>/migration/stop

Stop a DBaaS PostgreSQL migration

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-kafka-topic-acl-config

POST /dbaas-kafka/<name>/topic/acl-config

Add a Kafka topic ACL entry

Parameters:

parameters.username
parameters.name
parameters.permission
parameters.topic

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-integration

GET /dbaas-integration/<id>

Get a DBaaS Integration

Parameters:

parameters.id

Resources:

resources.dbaas_integration.status
resources.dbaas_integration.description

get-dbaas-service-metrics

POST /dbaas-service-metrics/<service-name>

Get metrics of DBaaS service

Parameters:

parameters.service_name
parameters.period

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-mysql-database

POST /dbaas-mysql/<service-name>/database

Create a DBaaS MySQL database

Parameters:

parameters.service_name
parameters.database_name

create-dbaas-kafka-user

POST /dbaas-kafka/<service-name>/user

Create a DBaaS Kafka user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

update-dbaas-service-grafana

PUT /dbaas-grafana/<name>

Update a DBaaS Grafana service

Parameters:

parameters.ip_filter
parameters.name
parameters.maintenance
parameters.plan
parameters.termination_protection
parameters.grafana_settings

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-settings-opensearch

GET /dbaas-settings-opensearch

Get DBaaS OpenSearch settings

reset-dbaas-mysql-user-password

PUT /dbaas-mysql/<service-name>/user/<username>/password/reset

Reset the credentials of a DBaaS mysql user

Parameters:

parameters.authentication
parameters.username
parameters.service_name
parameters.password

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

reveal-dbaas-mysql-user-password

GET /dbaas-mysql/<service-name>/user/<username>/password/reveal

Reveal the secrets of a DBaaS MySQL user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-postgres-user

POST /dbaas-postgres/<service-name>/user

Create a DBaaS Postgres user

Parameters:

parameters.username
parameters.service_name
parameters.allow_replication

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

start-dbaas-mysql-maintenance

PUT /dbaas-mysql/<name>/maintenance/start

Initiate MySQL maintenance update

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

start-dbaas-pg-maintenance

PUT /dbaas-postgres/<name>/maintenance/start

Initiate PostgreSQL maintenance update

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-service-mysql

GET /dbaas-mysql/<name>

Get a DBaaS MySQL service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-mysql-user

POST /dbaas-mysql/<service-name>/user

Create a DBaaS MySQL user

Parameters:

parameters.authentication
parameters.username
parameters.service_name

create-dbaas-pg-upgrade-check

POST /dbaas-postgres/<service>/upgrade-check

Parameters:

parameters.target_version
parameters.service

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-service-mysql

POST /dbaas-mysql/<name>

Create a DBaaS MySQL service

Parameters:

parameters.ip_filter
parameters.admin_password
parameters.binlog_retention_period
parameters.backup_schedule
parameters.name
parameters.mysql_settings
parameters.admin_username
parameters.migration
parameters.version
parameters.maintenance
parameters.plan
parameters.recovery_backup_time
parameters.fork_from_service
parameters.integrations
parameters.termination_protection

get-dbaas-service-type

GET /dbaas-service-type/<service-type-name>

Get a DBaaS service type

Parameters:

parameters.service_type_name

get-dbaas-service-pg

GET /dbaas-postgres/<name>

Get a DBaaS PostgreSQL service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-kafka-schema-registry-acl-config

POST /dbaas-kafka/<name>/schema-registry/acl-config

Add a Kafka Schema Registry ACL entry

Parameters:

parameters.resource
parameters.username
parameters.name
parameters.permission

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-service-redis

GET /dbaas-redis/<name>

Get a DBaaS Redis service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

reset-dbaas-kafka-user-password

PUT /dbaas-kafka/<service-name>/user/<username>/password/reset

Reset the credentials of a DBaaS Kafka user

Parameters:

parameters.username
parameters.service_name
parameters.password

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

reveal-dbaas-kafka-user-password

GET /dbaas-kafka/<service-name>/user/<username>/password/reveal

Reveal the secrets of a DBaaS Kafka user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-mysql-user

DELETE /dbaas-mysql/<service-name>/user/<username>

Delete a DBaaS MySQL user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-service-opensearch

GET /dbaas-opensearch/<name>

Get a DBaaS OpenSearch service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

reset-dbaas-opensearch-user-password

PUT /dbaas-opensearch/<service-name>/user/<username>/password/reset

Reset the credentials of a DBaaS OpenSearch user

Parameters:

parameters.username
parameters.service_name
parameters.password

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

reveal-dbaas-opensearch-user-password

GET /dbaas-opensearch/<service-name>/user/<username>/password/reveal

Reveal the secrets of a DBaaS OpenSearch user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-service-pg

POST /dbaas-postgres/<name>

Create a DBaaS PostgreSQL service

Parameters:

parameters.ip_filter
parameters.pglookout_settings
parameters.admin_password
parameters.synchronous_replication
parameters.pg_settings
parameters.backup_schedule
parameters.work_mem
parameters.name
parameters.admin_username
parameters.pgbouncer_settings
parameters.migration
parameters.version
parameters.maintenance
parameters.plan
parameters.recovery_backup_time
parameters.fork_from_service
parameters.integrations
parameters.termination_protection
parameters.shared_buffers_percentage
parameters.variant
parameters.timescaledb_settings

list-dbaas-services

GET /dbaas-service

List DBaaS services

get-dbaas-service-logs

POST /dbaas-service-logs/<service-name>

Get logs of DBaaS service

Parameters:

parameters.sort_order
parameters.offset
parameters.limit
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-service-pg

DELETE /dbaas-postgres/<name>

Delete a Postgres service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-pg-connection-pool

DELETE /dbaas-postgres/<service-name>/connection-pool/<connection-pool-name>

Delete a DBaaS PostgreSQL connection pool

Parameters:

parameters.connection_pool_name
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-settings-grafana

GET /dbaas-settings-grafana

Get DBaaS Grafana settings

create-dbaas-pg-connection-pool

POST /dbaas-postgres/<service-name>/connection-pool

Create a DBaaS PostgreSQL connection pool

Parameters:

parameters.username
parameters.mode
parameters.name
parameters.service_name
parameters.size
parameters.database_name

create-dbaas-integration

POST /dbaas-integration

Create a new DBaaS integration between two services

Parameters:

parameters.settings
parameters.source_service
parameters.dest_service
parameters.integration_type

get-dbaas-ca-certificate

GET /dbaas-ca-certificate

Get DBaaS CA Certificate

delete-dbaas-postgres-user

DELETE /dbaas-postgres/<service-name>/user/<username>

Delete a DBaaS Postgres user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

get-dbaas-migration-status

GET /dbaas-migration-status/<name>

Get a DBaaS migration status

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-service-opensearch

DELETE /dbaas-opensearch/<name>

Delete a OpenSearch service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-pg-database

POST /dbaas-postgres/<service-name>/database

Create a DBaaS Postgres database

Parameters:

parameters.lc_ctype
parameters.service_name
parameters.database_name
parameters.lc_collate

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-service-grafana

POST /dbaas-grafana/<name>

Parameters:

parameters.ip_filter
parameters.name
parameters.maintenance
parameters.plan
parameters.fork_from_service
parameters.termination_protection
parameters.grafana_settings

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

start-dbaas-redis-maintenance

PUT /dbaas-redis/<name>/maintenance/start

Initiate Redis maintenance update

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

start-dbaas-opensearch-maintenance

PUT /dbaas-opensearch/<name>/maintenance/start

Initiate OpenSearch maintenance update

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

update-dbaas-opensearch-acl-config

PUT /dbaas-opensearch/<name>/acl-config

Create a DBaaS OpenSearch ACL configuration

Parameters:

parameters.extended_acl_enabled
parameters.acl_enabled
parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-service-redis

POST /dbaas-redis/<name>

Create a DBaaS Redis service

Parameters:

parameters.ip_filter
parameters.redis_settings
parameters.name
parameters.recovery_backup_name
parameters.migration
parameters.maintenance
parameters.plan
parameters.fork_from_service
parameters.termination_protection

reset-dbaas-postgres-user-password

PUT /dbaas-postgres/<service-name>/user/<username>/password/reset

Reset the credentials of a DBaaS Postgres user

Parameters:

parameters.username
parameters.service_name
parameters.password

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

reveal-dbaas-postgres-user-password

GET /dbaas-postgres/<service-name>/user/<username>/password/reveal

Reveal the secrets of a DBaaS Postgres user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

start-dbaas-grafana-maintenance

PUT /dbaas-grafana/<name>/maintenance/start

Initiate Grafana maintenance update

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-service-kafka

DELETE /dbaas-kafka/<name>

Delete a Kafka service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-pg-database

DELETE /dbaas-postgres/<service-name>/database/<database-name>

Delete a DBaaS Postgres database

Parameters:

parameters.service_name
parameters.database_name

create-dbaas-opensearch-user

POST /dbaas-opensearch/<service-name>/user

Create a DBaaS OpenSearch user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

update-dbaas-service-opensearch

PUT /dbaas-opensearch/<name>

Update a DBaaS OpenSearch service

Parameters:

parameters.ip_filter
parameters.keep_index_refresh_interval
parameters.max_index_count
parameters.opensearch_dashboards
parameters.name
parameters.opensearch_settings
parameters.version
parameters.maintenance
parameters.plan
parameters.index_patterns
parameters.index_template
parameters.termination_protection

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

delete-dbaas-service-mysql

DELETE /dbaas-mysql/<name>

Delete a MySQL service

Parameters:

parameters.name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

create-dbaas-redis-user

POST /dbaas-redis/<service-name>/user

Create a DBaaS Redis user

Parameters:

parameters.authentication
parameters.username
parameters.service_name

delete-dbaas-redis-user

DELETE /dbaas-redis/<service-name>/user/<username>

Delete a DBaaS Redis user

Parameters:

parameters.username
parameters.service_name

reset-dbaas-redis-user-password

PUT /dbaas-redis/<service-name>/user/<username>/password/reset

Reset the credentials of a DBaaS Redis user

Parameters:

parameters.authentication
parameters.username
parameters.service_name
parameters.password

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

reveal-dbaas-redis-user-password

GET /dbaas-redis/<service-name>/user/<username>/password/reveal

Reveal the secrets of a DBaaS Redis user

Parameters:

parameters.username
parameters.service_name

Resources:

resources.dbaas_service.name
resources.dbaas_service.type
resources.dbaas_service.state
resources.dbaas_service.zone
resources.dbaas_service.plan
resources.dbaas_service.node_count

iam

delete-api-key

DELETE /api-key/<id>

Delete a v3 API key

Parameters:

parameters.id

Resources:

resources.api_key.key
resources.api_key.name
resources.api_key.role_id

list-access-key-known-operations

GET /access-key-known-operations

Retrieve all known available IAM Access Key operations and associated tags

create-api-key

POST /api-key

Create a new v3 API key

Parameters:

parameters.name
parameters.role_id

revoke-access-key

DELETE /access-key/<key>

Revoke an IAM Access Key

Parameters:

parameters.key

Resources:

resources.access_key.key
resources.access_key.tags
resources.access_key.name
resources.access_key.type
resources.access_key.version
resources.access_key.resources
resources.access_key.operations

list-iam-roles

GET /iam-role

List IAM Roles

get-access-key

GET /access-key/<key>

Retrieve IAM Access Key details

Parameters:

parameters.key

Resources:

resources.access_key.key
resources.access_key.tags
resources.access_key.name
resources.access_key.type
resources.access_key.version
resources.access_key.resources
resources.access_key.operations

update-iam-role

PUT /iam-role/<id>

Update IAM Role

Parameters:

parameters.permissions
parameters.id
parameters.labels
parameters.description

Resources:

resources.iam_role.editable
resources.iam_role.id
resources.iam_role.name
resources.iam_role.labels
resources.iam_role.description

get-iam-role

GET /iam-role/<id>

Retrieve IAM Role

Parameters:

parameters.id

Resources:

resources.iam_role.editable
resources.iam_role.id
resources.iam_role.name
resources.iam_role.labels
resources.iam_role.description

list-access-keys

GET /access-key

List IAM Access Keys

create-iam-role

POST /iam-role

Create IAM Role

Parameters:

parameters.permissions
parameters.editable
parameters.name
parameters.labels
parameters.policy
parameters.description

get-iam-organization-policy

GET /iam-organization-policy

Retrieve IAM Organization Policy

list-access-key-operations

GET /access-key-operations

Retrieve IAM Access Key operations and associated tags for the signing key

create-access-key

POST /access-key

Create an IAM Access Key

Parameters:

parameters.tags
parameters.name
parameters.resources
parameters.operations

get-api-key

GET /api-key/<id>

Get v3 API key

Parameters:

parameters.id

Resources:

resources.api_key.key
resources.api_key.name
resources.api_key.role_id

update-iam-role-policy

PUT /iam-role/<id>:policy

Update IAM Role Policy

Parameters:

parameters.services
parameters.id
parameters.default_service_strategy

Resources:

resources.iam_role.editable
resources.iam_role.id
resources.iam_role.name
resources.iam_role.labels
resources.iam_role.description

update-iam-organization-policy

PUT /iam-organization-policy

Update IAM Organization Policy

Parameters:

parameters.services
parameters.default_service_strategy

list-api-keys

GET /api-key

List v3 API keys

delete-iam-role

DELETE /iam-role/<id>

Delete IAM Role

Parameters:

parameters.id

Resources:

resources.iam_role.editable
resources.iam_role.id
resources.iam_role.name
resources.iam_role.labels
resources.iam_role.description

sos

list-sos-buckets-usage

GET /sos-buckets-usage

List SOS Buckets Usage

get-sos-presigned-url

GET /sos/<bucket>/presigned-url

Retrieve Presigned Download URL for SOS object

Parameters:

parameters.bucket
parameters.key

abort-multipart-upload

Parameters:

parameters.bucket
parameters.key

create-bucket

No parameters or resources

delete-bucket

Parameters:

parameters.bucket

delete-bucket-analytics-configuration

Parameters:

parameters.bucket

delete-bucket-cors

Parameters:

parameters.bucket

delete-bucket-encryption

Parameters:

parameters.bucket

delete-bucket-inventory-configuration

Parameters:

parameters.bucket

delete-bucket-lifecycle

Parameters:

parameters.bucket

delete-bucket-metrics-configuration

Parameters:

parameters.bucket

delete-bucket-ownership-controls

Parameters:

parameters.bucket

delete-bucket-policy

Parameters:

parameters.bucket

delete-bucket-replication

Parameters:

parameters.bucket

delete-bucket-tagging

Parameters:

parameters.bucket

delete-bucket-website

Parameters:

parameters.bucket

delete-object

Includes s3 operations: - DeleteObject - DeleteObjects

Parameters:

parameters.bucket
parameters.key
parameters.version_id

delete-object-tagging

Parameters:

parameters.bucket
parameters.key
parameters.version_id

get-bucket-accelerate-configuration

Parameters:

parameters.bucket

get-bucket-acl

Parameters:

parameters.bucket

get-bucket-analytics-configuration

Parameters:

parameters.bucket

get-bucket-cors

Parameters:

parameters.bucket

get-bucket-encryption

Parameters:

parameters.bucket

get-bucket-inventory-configuration

Parameters:

parameters.bucket

get-bucket-lifecycle

Parameters:

parameters.bucket

get-bucket-location

Parameters:

parameters.bucket

get-bucket-logging

Parameters:

parameters.bucket

get-bucket-metrics-configuration

Parameters:

parameters.bucket

get-bucket-notification-configuration

Parameters:

parameters.bucket

get-bucket-ownership-controls

Parameters:

parameters.bucket

get-bucket-policy

Parameters:

parameters.bucket

get-bucket-replication

Parameters:

parameters.bucket

get-bucket-request-payment

Parameters:

parameters.bucket

get-bucket-tagging

Parameters:

parameters.bucket

get-bucket-versioning

Parameters:

parameters.bucket

get-bucket-website

Parameters:

parameters.bucket

get-object

Includes s3 operations: - GetObject - CopyObject (combined with put-object permissions on the target object) - UploadPartCopy (combined with put-object permissions on the target object)

Parameters:

parameters.bucket
parameters.key
parameters.version_id

get-object-acl

Parameters:

parameters.bucket
parameters.key
parameters.version_id

get-object-legal-hold

Parameters:

parameters.bucket
parameters.key
parameters.version_id

get-object-lock-configuration

Parameters:

parameters.bucket

get-object-retention

Parameters:

parameters.bucket
parameters.key
parameters.version_id

get-object-tagging

Parameters:

parameters.bucket
parameters.key
parameters.version_id

head-bucket

Parameters:

parameters.bucket

head-object

Parameters:

parameters.bucket
parameters.key
parameters.version_id

list-bucket-analytics-configuration

Parameters:

parameters.bucket

list-bucket-inventory-configuration

Parameters:

parameters.bucket

list-bucket-metrics-configuration

Parameters:

parameters.bucket

list-buckets

No parameters or resources

list-multipart-uploads

Parameters:

parameters.bucket
parameters.prefix

list-object-versions

Parameters:

parameters.bucket
parameters.prefix

list-objects

Parameters:

parameters.bucket
parameters.prefix

put-bucket-accelerate-configuration

Parameters:

parameters.bucket

put-bucket-acl

Parameters:

parameters.bucket

put-bucket-analytics-configuration

Parameters:

parameters.bucket

put-bucket-cors

Parameters:

parameters.bucket

put-bucket-encryption

Parameters:

parameters.bucket

put-bucket-inventory-configuration

Parameters:

parameters.bucket

put-bucket-lifecycle

Parameters:

parameters.bucket

put-bucket-logging

Parameters:

parameters.bucket

put-bucket-metrics-configuration

Parameters:

parameters.bucket

put-bucket-notification

Parameters:

parameters.bucket

put-bucket-ownership-controls

Parameters:

parameters.bucket

put-bucket-policy

Parameters:

parameters.bucket

put-bucket-replication

Parameters:

parameters.bucket

put-bucket-request-payment

Parameters:

parameters.bucket

put-bucket-tagging

Parameters:

parameters.bucket

put-bucket-versioning

Parameters:

parameters.bucket

put-bucket-website

Parameters:

parameters.bucket

put-object

Includes s3 operations: - PutObject - PostObject - UploadPart - CreateMultipartUpload - CompleteMultipartUpload - ListParts - CopyObject (combined with get-object permissions on the source object) - UploadPartCopy (combined with get-object permissions on the source object)

Parameters:

parameters.bucket
parameters.key

For CopyObject,UploadPartCopy and UploadPartCopyRange operations, context has additional parameters: