Kubernetes Service API

Introduction Deploy highly available containerized apps in Kubernetes clusters and use the powerful tools of IBM Cloud Kubernetes Service to automate, isolate, secure, manage, and monitor your workloa

MethodPathSummary
Delete the autoscaling configuration for an ALB
Get the autoscaling configuration for an ALB
Set the autoscaling configuration for an ALB
Create an Ingress domain for a cluster
Deprecated: Delete external domain provider credential
Delete a non-default Ingress domain for a cluster
Deprecated: Get external domain provider credential metadata
Replace the existing default Ingress domain for a cluster
Deprecated: Set external domain provider credential
Update an Ingress domain for a cluster
Get configuration of load balancers for Ingress ALBs
Update the configuration of load balancers for Ingress ALBs
Add fields to an Ingress secret with a secret stored in IBM Cloud Secrets Man
Create an Ingress secret with a secret stored in IBM Cloud Secrets Manager
Delete an Ingress secret from the cluster
View Ingress secret details
View Ingress secrets for a cluster
Remove fields from an Ingress secret with a secret stored in IBM Cloud Secret
Update an Ingress secret with a secret stored in IBM Cloud Secrets Manager
View an IBM Cloud Secrets Manager instance registered to the cluster
View IBM Cloud Secrets Manager instances registered to the cluster
Register an IBM Cloud Secrets Manager instance to the cluster
Unregister an IBM Cloud Secrets Manager instance from the cluster
Update an IBM Cloud Secrets Manager instance registration configuration to th
Get the configuration of a cluster's port 80 security settings
Enable port 80 on the cluster
Get the OAuth access type for a VPC cluster
Set the OAuth access type for a VPC cluster
Modify the outbound traffic protection policy for a VPC cluster using Secure
Disable the subnet allowlist for a Satellite cluster's service endpoint
Get a Satellite cluster's service endpoint allowlist
Add subnets to a Satellite cluster's service endpoint allowlist
Enable the subnet allowlist for a Satellite cluster's service endpoint
Remove subnets from a Satellite cluster's service endpoint allowlist
Deprecated: Private service endpoint allowlists are no longer supported and c
Deprecated: Private service endpoint allowlists are no longer supported and c
Deprecated: Private service endpoint allowlists are no longer supported and c
Deprecated: Private service endpoint allowlists are no longer supported and c
Deprecated: Private service endpoint allowlists are no longer supported and c
Enable VPC Secure by Default Networking on an existing VPC cluster
Perform operations against a VPC Security Group associated with a cluster
List all security groups associated with a cluster
List available add-ons that you can enable in a cluster
List configuration values for your IBM Cloud account
List available machine types for a zone (data center)
Deprecated: List available Kubernetes versions
List available locations
View the current messages
List product-specific values to substitute for variables in other files
Deprecated: List available Kubernetes Service regions
List available IBM Cloud Kubernetes Service versions
List available zones (data centers)
View the current messages
Enable an existing ALB in a cluster
Disable an ALB in your cluster
View details of an ALB
List all ALBs in a cluster
Force a one-time update of all ALB pods to the latest build
Check if automatic updates for Ingress ALBs are enabled in a cluster
Enable or disable automatic updates for the Ingress ALBs in a cluster
Create a public or private ALB in a specified zone and VLAN
List the clusters that you have access to
Create a cluster
Delete a cluster
View details for a cluster
Update the version of the Kubernetes cluster master node
View details of the add-ons that are enabled in a cluster
Enable, disable, or update add-ons for a cluster
Get the cluster-specific configuration and certificates
Create and enable a key management service (KMS) provider configuration for a
Refresh the Kubernetes master
List the IBM Cloud services bound to a cluster across all namespaces
Bind an IBM Cloud service to a cluster
List the IBM Cloud services bound to a specific namespace in a cluster
Unbind an IBM Cloud service from a cluster
List classic subnets that are bound to a cluster
Detach a public or private portable subnet from a cluster
Add an IBM Cloud classic infrastructure subnet to a cluster
List user-managed subnets that are bound to a cluster
Add an existing user-managed subnet to a cluster
Remove a user-managed subnet from a cluster
Create an IBM Cloud classic infrastructure subnet and add it to an existing c
List all webhooks for a cluster
Add a webhook to a cluster
List the worker pools in a cluster
Create a worker pool for a cluster
Remove a worker pool from a cluster
View details for a worker pool
Resize or rebalance a worker pool
Add a zone to the specified worker pool for a cluster
Remove a zone from a worker pool
Update the network configuration details, such as VLANs, for a zone in the wo
List all worker nodes in a cluster
Add worker nodes to a cluster
Delete a worker node from a cluster
View details of a worker node
Reboot, reload, or update a worker node for a cluster
Delete an audit webhook configuration
View details for an audit webhook configuration
Create or update an audit webhook configuration for a cluster
Remove IBM Cloud classic infrastructure account credentials from your IBM Clo
View the IBM Cloud classic infrastructure account credentials that are set fo
Set IBM Cloud classic infrastructure account credentials for your IBM Cloud K
Get details on the permissions that the IBM Cloud infrastructure (SoftLayer)
Reset the IAM API key
View the VLAN spanning status
List available VLANs for a zone
List available IBM Cloud classic infrastructure subnets
View information about the containers-kubernetes-key API key owner
View the default logging endpoint for the target region
Delete all log forwarding configurations for a cluster
List all log forwarding configurations in the cluster
List all log forwarding configurations for a log source in the cluster
Create a log forwarding configuration
Delete a log forwarding configuration
Update a log forwarding configuration
Refresh the cluster's logging configuration
Check if automatic updates for the Fluentd logging add-on are enabled in the
Enable or diable automatic updates for the Fluentd logging add-on in the clus
Deletes all logging filter configurations for the cluster
List all logging filter configurations in the cluster
Create a logging filter configuration
Delete a logging filter configuration
View a logging filter configuration
Update a logging filter configuration
Update a DNS record by adding an NLB IP address
Remove an IP address from an NLB subdomain
List registered NLB subdomains and NLB IP addresses
Create a new NLB subdomain and associate one or more NLB IP addresses with it
Enable or disable a health check monitor for an NLB subdomain
Configure a health check monitor for an NLB subdomain
View the health check monitor settings for an NLB subdomain
List the health check monitor settings for all NLB subdomains
Deprecated: List the health check status for the IPs behind NLB subdomains in
View a user's ability to create free and standard clusters in a region and re
Ignore specific ingress status errors in ingress status reporting
View details of an ALB
List supported Ingress controller images
List all ALBs in a cluster
Get the status of the in-cluster ALB health checker
Get the status of the ingress resources in a cluster
List all ingress status errors that are ignored for the cluster
Unignore specific ingress status errors in ingress status reporting
Set the in-cluster ingress health checker
Set the state of the ingress status
Update ALBs in a cluster
Create a public or private ALB in a specified zone and VPC cluster
Disable an ALB in your VPC cluster
Enable an existing ALB in a VPC cluster
Start applying IAM roles corresponding to your access to the cluster
Start applying IAM roles corresponding to your access to the cluster, then re
Set the autoupdate status of the cluster master
Detailed cluster information
List the classic clusters that you have access to
Get if VRF and Service Endpoint is enabled for the given account in the selec
List available classic infrastructure VLANs for a zone
View details of a worker node for classic cluster
View details of a worker pool for a classic cluster
View details of a worker pool for a classic cluster
View all workers for a classic cluster
Create a dedicated host
Create a dedicated host pool
Disable dedicated host placement
Enable dedicated host placement
Enables KMS in a cluster
Get the cluster's CA cert
List the root keys for a Key Management Service instance
View details for a cluster
View details of the add-ons that are enabled in a cluster
View details of a dedicated host
View details of a dedicated host pool
List the dedicated host pools
List the dedicated hosts
Get the details for a worker node flavor
List available flavors types for a VPC zone (data center)
Gets KMS instances tied to an account
Get the cluster's kubeconfig file
List supported operating systems
View the quota for resources per region in the account
Get the RBACSync status
View details of a worker node for cluster
View details of a worker pool for a cluster
List the worker pools in a cluster
View all workers for cluster
Validates user provided entitlement
Rebalance workers in a worker pool
Refresh the Kubernetes master
Removes a dedicated host
Removes a dedicated host pool
Delete a worker node from a cluster
Removes a worker pool
Remove a zone from a worker pool
Resize an existing worker pool
Set custom labels for a worker pool
Set the operating system of a worker pool
Set custom taints for a worker pool
Create a VPC cluster
Create a worker pool for a VPC cluster
Create a zone in the specified worker pool for a VPC cluster
Get details of a VPC cluster
List the VPC clusters that you have access to
View subnets for a given VPC
View details of a VPC
View VPCs for the given provider
View details of a worker node for VPC cluster
View details of a worker pool for a VPC cluster
List the worker pools in a VPC cluster
View all workers for VPC cluster
List available zones in a region
Replace a worker node with a new worker node
Get detailed information for one health issue (regional URL prefix)
List aggregated health issues for a cluster (regional URL prefix)
V2Disableimagesecurity
V2Enableimagesecurity
Deprecated: Disable the Pod Security Policy admission controller
Deprecated: Enable the Pod Security Policy admission controller
View the Pod Security admission control configuration for a cluster
Deprecated: View the Pod Security Policy admission control configuration
Deprecated: Remove the Pod Security admission controller configuration for Ku
Set the Pod Security admission controller configuration
Disables a private service endpoint for a cluster
Disables a public service endpoint for a cluster
Enables the private service endpoint for a cluster
Enables the public service endpoint for a cluster
Create an image pull secret to IBM Cloud Container Registry in the `default`
List available cluster versions
Replace a worker node with a new worker node
Update the version of the Kubernetes cluster master node
Update the health monitoring configuration for the specified NLB subdomain in
Remove a secret from an NLB subdomain
Get the health monitoring configuration for the specified NLB subdomain in a
List registered NLB subdomains in a cluster
Get the details for the specified NLB subdomain in a cluster
Get the details for the specified subdomain in a Satellite location
List registered NLB subdomains in a Satellite location
Regenerates cert for secret
Registers domains: c001, c002, c003, each tied to a corresponding IP and c000
Create a new NLB subdomain in a VPC cluster and associate a load balancer hos
Remove the load balancer hostname from the DNS record for an existing NLB sub
Update the DNS record for an NLB subdomain by replacing the load balancer hos
Do not use it as this endpoint is not supported in the long term
Create an IBM Cloud Satellite cluster
Create a worker pool for an IBM Cloud Satellite cluster
Create a zone in the specified worker pool for an IBM Cloud Satellite cluster
List the IBM Cloud Satellite clusters that you have access to
Create an IBM Cloud Satellite cluster in a location that does not belong to y
List the clusters in an IBM Cloud Satellite location that are associated with
Create an IBM Cloud Satellite location
Get the details for an IBM Cloud Satellite location
List the IBM Cloud Satellite locations that you have access to
Remove an IBM Cloud Satellite Location
Assign a host to an IBM Cloud Satellite location or cluster
Attach a host to an IBM Cloud Satellite location
List the hosts in your IBM Cloud Satellite location
Remove a host from an IBM Cloud Satellite location or cluster
Update a host in your IBM Cloud Satellite location
Createattachment
Detach volume from given worker
Getattachment
Getattachments
Get the details of a storage volume
List storage volumes for a cluster or for the account if no cluster is provided
Acknowledge the request to expand storage capacity
Create an assignment using a Satellite storage configuration for the cluster
Create an assignment using a Satellite storage configuration for a Satellite
Deprecated. To create a Satellite storage configuration, you can use /v2/stor
Create a Satellite storage configuration
Expand the capacity of a storage request
List Satellite storage configurations assigned to a Satellite cluster or serv
View details of an assignment
Deprecated. To view details of an assignment, you can use /v2/storage/satelli
List storage assignments in the IBM Cloud account
List storage assignments created for a Satellite cluster or service cluster
List storage assignments by configuration name or UUID
List storage assignments in a Satellite location
List and filter available storage classes from assigned Satellite storage con
List Storage requests on a cluster
View details of a Satellite storage configuration
List Satellite storage configurations
List Satellite storage configurations in a Satellite location
View the details of a Satellite storage template
View the change log details of Satellite storage templates
List Satellite storage templates
Remove an assignment
Delete a storage request
Remove a Satellite storage configuration
Enable or disable automatic upgrades for an existing storage assignment(s)
Create a storage request on a cluster
Update an assignment
Deprecated. To update a Satellite storage configuration, you can use /v2/stor
Update a Satellite storage configuration
Update a Satellite storage configuration to use the latest template revision
Acknowledge the request to expand storage capacity
Create an assignment using a Satellite storage configuration for the cluster
Create an assignment using a Satellite storage configuration for a Satellite
Deprecated. To create a Satellite storage configuration, you can use /v2/stor
Create a Satellite storage configuration
Expand the capacity of a storage request
List Satellite storage configurations assigned to a Satellite cluster or serv
View details of an assignment
Deprecated. To view details of an assignment, you can use /v2/storage/satelli
List storage assignments in the IBM Cloud account
List storage assignments created for a Satellite cluster or service cluster
List storage assignments by configuration name or UUID
List storage assignments in a Satellite location
List and filter available storage classes from assigned Satellite storage con
List Storage requests on a cluster
View details of a Satellite storage configuration
List Satellite storage configurations
List Satellite storage configurations in a Satellite location
View the details of a Satellite storage template
View the change log details of Satellite storage templates
List Satellite storage templates
Remove an assignment
Delete a storage request
Remove a Satellite storage configuration
Enable or disable automatic upgrades for an existing storage assignment(s)
Create a storage request on a cluster
Update an assignment
Deprecated. To update a Satellite storage configuration, you can use /v2/stor
Update a Satellite storage configuration
Update a Satellite storage configuration to use the latest template revision