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 workloads across cloud locations. Use the IBM Cloud Kubernetes Service API to manage your Kubernetes cluster infrastructure in IBM Cloud. For example, you can create clusters; add capacity for your workloads by resizing worker pools; manage networking, storage, and logging resources that are attached to your cluster; and enable IBM Cloud add-ons to optimize your cluster management experience. To use the Kubernetes API to manage your application workloads within your cluster, see the product documentationhttps://cloud.ibm.com/docs/containers?topic=containers-csapiinstallkubeapi. Before you begin - Make sure that you have access to a paid IBM Cloud accounthttps://cloud.ibm.com/registration. - Choose a strategyhttps://cloud.ibm.com/docs/containers?topic=containers-strategy for setting up and maintaining a cluster. This process includes choosing worker node flavors, setting up networking, and selecting the highest available configuration as possible. Charges With IBM Cloud Kubernetes Service clusters, you can use IBM Cloud infrastructure compute, networking, and storage resources with platform services such as Watson AI or Compose Database-as-a-Service. Each resource might entail its own charges that can be fixed, metered, tiered, or reserved. For more information, see What am I charged for when I use IBM Cloud Kubernetes Service?https://cloud.ibm.com/docs/containers?topic=containers-faqscharges Authentication The IBM Cloud Kubernetes Service API uses IBM Cloud Identity and Access Management IAM to authenticate requests. Pass a bearer token in an Authorization header or an apikey. Tokens support authenticated requests without embedding service credentials in every call. Authorization To use the IBM Cloud Kubernetes Service API, you must be authorized to work with the service in IBM Cloud Identity and Access Management IAM. The service uses IAM platform and service access roles to determine your permissions and the actions that you can perform. Make sure that you are assigned Permissions to create a clusterhttps://cloud.ibm.com/docs/containers?topic=containers-iam-platform-access-rolescluster-create-permissions. Beginning with version 4.0.0, the Node SDK returns a Promise for all methods when a callback isn't specified. The package location moved to ibm-watson. It's available at watson-developer-cloud but is not updated there. Use ibm-watson to stay up to date. IAM and Activity Tracker actions by API method For a list of the IBM Cloud Identity and Access Management IAM action and Activity Tracker events by API method, see the product documentationhttps://cloud.ibm.com/docs/containers?topic=containers-iam-platform-access-roles. API endpoint Use the following API endpoint for all API requests: sh https://containers.cloud.ibm.com/global Versioning The API is versioned to support the different infrastructure providers that are available for you to create clusters. All /v1 APIs can be used to work only with IBM Cloud classic infrastructure. To work with a cluster that was provisioned on IBM Virtual Private Cloud VPC infrastructure, you must use the /v2 API. For information about the API versions, see About the APIhttps://cloud.ibm.com/docs/containers?topic=containers-csapiinstallapiabout. Error handling This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error. | HTTP error code | Description | Recovery | |-----------------|-------------|----------| | 200 | Success | The request was successful. | | 400 | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Include all required parameters in your request. | | 401 | Unauthorized | You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions. | | 403 | Forbidden | The supplied authentication is not authorized to access the cluster or an associated cluster resource. Check that you have the correct access credentials and permissions. | | 404 | Not Found | The requested resource could not be found. | | 408 | Request Timeout | The connection to the server timed out. Wait a few minutes, then try again. | | 409 | Conflict | The cluster or an associated cluster resource with the same name or ID already exists. | | 500 | Internal Server Error | IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support. |
| Method | Path | Summary |
|---|---|---|
| DELETE | /ingress/v2/clusters/{idOrName}/albs/{albID}/autoscale | Delete the autoscaling configuration for an ALB. |
| GET | /ingress/v2/clusters/{idOrName}/albs/{albID}/autoscale | Get the autoscaling configuration for an ALB. |
| PUT | /ingress/v2/clusters/{idOrName}/albs/{albID}/autoscale | Set the autoscaling configuration for an ALB. |
| POST | /ingress/v2/dns/createDomain | Create an Ingress domain for a cluster. |
| POST | /ingress/v2/dns/deleteCredential | Deprecated: Delete external domain provider credential. |
| POST | /ingress/v2/dns/deleteDomain | Delete a non-default Ingress domain for a cluster. |
| GET | /ingress/v2/dns/getCredential | Deprecated: Get external domain provider credential metadata. |
| POST | /ingress/v2/dns/replaceDefaultSubdomain | Replace the existing default Ingress domain for a cluster. |
| POST | /ingress/v2/dns/setCredential | Deprecated: Set external domain provider credential. |
| POST | /ingress/v2/dns/updateDomain | Update an Ingress domain for a cluster. |
| GET | /ingress/v2/load-balancer/configuration | Get configuration of load balancers for Ingress ALBs. |
| PATCH | /ingress/v2/load-balancer/configuration | Update the configuration of load balancers for Ingress ALBs. |
| POST | /ingress/v2/secret/addField | Add fields to an Ingress secret with a secret stored in IBM Cloud Secrets Manager. |
| POST | /ingress/v2/secret/createSecret | Create an Ingress secret with a secret stored in IBM Cloud Secrets Manager. |
| POST | /ingress/v2/secret/deleteSecret | Delete an Ingress secret from the cluster. |
| GET | /ingress/v2/secret/getSecret | View Ingress secret details. |
| GET | /ingress/v2/secret/getSecrets | View Ingress secrets for a cluster. |
| POST | /ingress/v2/secret/removeField | Remove fields from an Ingress secret with a secret stored in IBM Cloud Secrets Manager. |
| POST | /ingress/v2/secret/updateSecret | Update an Ingress secret with a secret stored in IBM Cloud Secrets Manager. |
| GET | /ingress/v2/secret/getInstance | View an IBM Cloud Secrets Manager instance registered to the cluster. |
| GET | /ingress/v2/secret/getInstances | View IBM Cloud Secrets Manager instances registered to the cluster. |
| POST | /ingress/v2/secret/registerInstance | Register an IBM Cloud Secrets Manager instance to the cluster. |
| POST | /ingress/v2/secret/unregisterInstance | Unregister an IBM Cloud Secrets Manager instance from the cluster. |
| POST | /ingress/v2/secret/updateInstance | Update an IBM Cloud Secrets Manager instance registration configuration to the cluster. |
| GET | /ingress/v2/security/port80 | Get the configuration of a cluster's port 80 security settings. |
| PATCH | /ingress/v2/security/port80 | Enable port 80 on the cluster. |
| GET | /network/v2/oauth-access-type/{idOrName} | Get the OAuth access type for a VPC cluster. |
| POST | /network/v2/oauth-access-type/{idOrName}/set | Set the OAuth access type for a VPC cluster. |
| POST | /network/v2/outbound-traffic-protection | Modify the outbound traffic protection policy for a VPC cluster using Secure by Default Networking. |
| DELETE | /network/v2/satellite-acl/{idOrName} | Disable the subnet allowlist for a Satellite cluster's service endpoint. |
| GET | /network/v2/satellite-acl/{idOrName} | Get a Satellite cluster's service endpoint allowlist. |
| PATCH | /network/v2/satellite-acl/{idOrName}/add | Add subnets to a Satellite cluster's service endpoint allowlist. |
| POST | /network/v2/satellite-acl/{idOrName}/enable | Enable the subnet allowlist for a Satellite cluster's service endpoint. |
| PATCH | /network/v2/satellite-acl/{idOrName}/rm | Remove subnets from a Satellite cluster's service endpoint allowlist. |
| DELETE | /v1/acl/{idOrName} | Deprecated: Private service endpoint allowlists are no longer supported and context based restrictions (CBR) should be used instead. For more details visit: https://cloud.ibm.com/docs/containers?topic=containers-pse-to-cbr-migration |
| GET | /v1/acl/{idOrName} | Deprecated: Private service endpoint allowlists are no longer supported and context based restrictions (CBR) should be used instead. For more details visit: https://cloud.ibm.com/docs/containers?topic=containers-pse-to-cbr-migration |
| PATCH | /v1/acl/{idOrName}/add | Deprecated: Private service endpoint allowlists are no longer supported and context based restrictions (CBR) should be used instead. For more details visit: https://cloud.ibm.com/docs/containers?topic=containers-pse-to-cbr-migration |
| POST | /v1/acl/{idOrName}/enable | Deprecated: Private service endpoint allowlists are no longer supported and context based restrictions (CBR) should be used instead. For more details visit: https://cloud.ibm.com/docs/containers?topic=containers-pse-to-cbr-migration |
| PATCH | /v1/acl/{idOrName}/rm | Deprecated: Private service endpoint allowlists are no longer supported and context based restrictions (CBR) should be used instead. For more details visit: https://cloud.ibm.com/docs/containers?topic=containers-pse-to-cbr-migration |
| POST | /network/v2/secure-by-default/enable | Enable VPC Secure by Default Networking on an existing VPC cluster. |
| POST | /network/v2/security-group | Perform operations against a VPC Security Group associated with a cluster. |
| GET | /network/v2/security-group/getSecurityGroups | List all security groups associated with a cluster. |
| GET | /v1/addons | List available add-ons that you can enable in a cluster. |
| GET | /v1/config | List configuration values for your IBM Cloud account. |
| GET | /v1/datacenters/{datacenter}/machine-types | List available machine types for a zone (data center). |
| GET | /v1/kube-versions | Deprecated: List available Kubernetes versions. |
| GET | /v1/locations | List available locations. |
| GET | /v1/messages | View the current messages. |
| GET | /v1/prodconfig | List product-specific values to substitute for variables in other files. |
| GET | /v1/regions | Deprecated: List available Kubernetes Service regions. |
| GET | /v1/versions | List available IBM Cloud Kubernetes Service versions. |
| GET | /v1/zones | List available zones (data centers). |
| GET | /v2/getMessages | View the current messages. |
| POST | /v1/alb/albs | Enable an existing ALB in a cluster. |
| DELETE | /v1/alb/albs/{albID} | Disable an ALB in your cluster. |
| GET | /v1/alb/albs/{albID} | View details of an ALB. |
| GET | /v1/alb/clusters/{idOrName} | List all ALBs in a cluster. |
| PUT | /v1/alb/clusters/{idOrName}/update | Force a one-time update of all ALB pods to the latest build. |
| GET | /v1/alb/clusters/{idOrName}/updatepolicy | Check if automatic updates for Ingress ALBs are enabled in a cluster. |
| PUT | /v1/alb/clusters/{idOrName}/updatepolicy | Enable or disable automatic updates for the Ingress ALBs in a cluster. |
| POST | /v1/alb/clusters/{idOrName}/zone/{zoneId} | Create a public or private ALB in a specified zone and VLAN. |
| GET | /v1/clusters | List the clusters that you have access to. |
| POST | /v1/clusters | Create a cluster. |
| DELETE | /v1/clusters/{idOrName} | Delete a cluster. |
| GET | /v1/clusters/{idOrName} | View details for a cluster. |
| PUT | /v1/clusters/{idOrName} | Update the version of the Kubernetes cluster master node. |
| GET | /v1/clusters/{idOrName}/addons | View details of the add-ons that are enabled in a cluster. |
| PATCH | /v1/clusters/{idOrName}/addons | Enable, disable, or update add-ons for a cluster. |
| GET | /v1/clusters/{idOrName}/config | Get the cluster-specific configuration and certificates. |
| POST | /v1/clusters/{idOrName}/kms | Create and enable a key management service (KMS) provider configuration for a cluster. |
| PUT | /v1/clusters/{idOrName}/masters | Refresh the Kubernetes master. |
| GET | /v1/clusters/{idOrName}/services | List the IBM Cloud services bound to a cluster across all namespaces. |
| POST | /v1/clusters/{idOrName}/services | Bind an IBM Cloud service to a cluster. |
| GET | /v1/clusters/{idOrName}/services/{namespace} | List the IBM Cloud services bound to a specific namespace in a cluster. |
| DELETE | /v1/clusters/{idOrName}/services/{namespace}/{serviceInstanceId} | Unbind an IBM Cloud service from a cluster. |
| GET | /v1/clusters/{idOrName}/subnets | List classic subnets that are bound to a cluster. |
| PATCH | /v1/clusters/{idOrName}/subnets/{subnetId} | Detach a public or private portable subnet from a cluster. |
| PUT | /v1/clusters/{idOrName}/subnets/{subnetId} | Add an IBM Cloud classic infrastructure subnet to a cluster. |
| GET | /v1/clusters/{idOrName}/usersubnets | List user-managed subnets that are bound to a cluster. |
| POST | /v1/clusters/{idOrName}/usersubnets | Add an existing user-managed subnet to a cluster. |
| DELETE | /v1/clusters/{idOrName}/usersubnets/{subnetId}/vlans/{vlanId} | Remove a user-managed subnet from a cluster. |
| POST | /v1/clusters/{idOrName}/vlans/{vlanId} | Create an IBM Cloud classic infrastructure subnet and add it to an existing cluster. |
| GET | /v1/clusters/{idOrName}/webhooks | List all webhooks for a cluster. |
| POST | /v1/clusters/{idOrName}/webhooks | Add a webhook to a cluster. |
| GET | /v1/clusters/{idOrName}/workerpools | List the worker pools in a cluster. |
| POST | /v1/clusters/{idOrName}/workerpools | Create a worker pool for a cluster. |
| DELETE | /v1/clusters/{idOrName}/workerpools/{poolidOrName} | Remove a worker pool from a cluster. |
| GET | /v1/clusters/{idOrName}/workerpools/{poolidOrName} | View details for a worker pool. |
| PATCH | /v1/clusters/{idOrName}/workerpools/{poolidOrName} | Resize or rebalance a worker pool. |
| POST | /v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones | Add a zone to the specified worker pool for a cluster. |
| DELETE | /v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones/{zoneid} | Remove a zone from a worker pool. |
| PATCH | /v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones/{zoneid} | Update the network configuration details, such as VLANs, for a zone in the worker pool. |
| GET | /v1/clusters/{idOrName}/workers | List all worker nodes in a cluster. |
| POST | /v1/clusters/{idOrName}/workers | Add worker nodes to a cluster. |
| DELETE | /v1/clusters/{idOrName}/workers/{workerId} | Delete a worker node from a cluster. |
| GET | /v1/clusters/{idOrName}/workers/{workerId} | View details of a worker node. |
| PUT | /v1/clusters/{idOrName}/workers/{workerId} | Reboot, reload, or update a worker node for a cluster. |
| DELETE | /v1/clusters/{idOrName}/apiserverconfigs/auditwebhook | Delete an audit webhook configuration. |
| GET | /v1/clusters/{idOrName}/apiserverconfigs/auditwebhook | View details for an audit webhook configuration. |
| PUT | /v1/clusters/{idOrName}/apiserverconfigs/auditwebhook | Create or update an audit webhook configuration for a cluster. |
| DELETE | /v1/credentials | Remove IBM Cloud classic infrastructure account credentials from your IBM Cloud Kubernetes Service account. |
| GET | /v1/credentials | View the IBM Cloud classic infrastructure account credentials that are set for your IBM Cloud Kubernetes Service account. |
| POST | /v1/credentials | Set IBM Cloud classic infrastructure account credentials for your IBM Cloud Kubernetes Service account. |
| GET | /v1/infra-permissions | Get details on the permissions that the IBM Cloud infrastructure (SoftLayer) credentials have. |
| POST | /v1/keys | Reset the IAM API key. |
| GET | /v1/subnets/vlan-spanning | View the VLAN spanning status. |
| GET | /v1/datacenters/{datacenter}/vlans | List available VLANs for a zone. |
| GET | /v1/subnets | List available IBM Cloud classic infrastructure subnets. |
| GET | /v1/logging/{idOrName}/clusterkeyowner | View information about the containers-kubernetes-key API key owner. |
| GET | /v1/logging/{idOrName}/default | View the default logging endpoint for the target region. |
| DELETE | /v1/logging/{idOrName}/loggingconfig | Delete all log forwarding configurations for a cluster. |
| GET | /v1/logging/{idOrName}/loggingconfig | List all log forwarding configurations in the cluster. |
| GET | /v1/logging/{idOrName}/loggingconfig/{logSource} | List all log forwarding configurations for a log source in the cluster. |
| POST | /v1/logging/{idOrName}/loggingconfig/{logSource} | Create a log forwarding configuration. |
| DELETE | /v1/logging/{idOrName}/loggingconfig/{logSource}/{id} | Delete a log forwarding configuration. |
| PUT | /v1/logging/{idOrName}/loggingconfig/{logSource}/{id} | Update a log forwarding configuration. |
| PUT | /v1/logging/{idOrName}/refresh | Refresh the cluster's logging configuration. |
| GET | /v1/logging/{idOrName}/updatepolicy | Check if automatic updates for the Fluentd logging add-on are enabled in the cluster. |
| PUT | /v1/logging/{idOrName}/updatepolicy | Enable or diable automatic updates for the Fluentd logging add-on in the cluster. |
| DELETE | /v1/logging/{idOrName}/filterconfigs | Deletes all logging filter configurations for the cluster. |
| GET | /v1/logging/{idOrName}/filterconfigs | List all logging filter configurations in the cluster. |
| POST | /v1/logging/{idOrName}/filterconfigs | Create a logging filter configuration. |
| DELETE | /v1/logging/{idOrName}/filterconfigs/{id} | Delete a logging filter configuration. |
| GET | /v1/logging/{idOrName}/filterconfigs/{id} | View a logging filter configuration. |
| PUT | /v1/logging/{idOrName}/filterconfigs/{id} | Update a logging filter configuration. |
| PUT | /v1/nlb-dns/clusters/{idOrName}/add | Update a DNS record by adding an NLB IP address. |
| DELETE | /v1/nlb-dns/clusters/{idOrName}/host/{nlbHost}/ip/{nlbIP}/remove | Remove an IP address from an NLB subdomain. |
| GET | /v1/nlb-dns/clusters/{idOrName}/list | List registered NLB subdomains and NLB IP addresses. |
| POST | /v1/nlb-dns/clusters/{idOrName}/register | Create a new NLB subdomain and associate one or more NLB IP addresses with it. |
| PUT | /v1/nlb-dns/clusters/{idOrName}/health | Enable or disable a health check monitor for an NLB subdomain. |
| PATCH | /v1/nlb-dns/health/clusters/{idOrName}/config | Configure a health check monitor for an NLB subdomain. |
| GET | /v1/nlb-dns/health/clusters/{idOrName}/host/{nlbHost}/config | View the health check monitor settings for an NLB subdomain. |
| GET | /v1/nlb-dns/health/clusters/{idOrName}/list | List the health check monitor settings for all NLB subdomains. |
| GET | /v1/nlb-dns/health/clusters/{idOrName}/status | Deprecated: List the health check status for the IPs behind NLB subdomains in a cluster. |
| GET | /v1/user-config | View a user's ability to create free and standard clusters in a region and resource group. |
| POST | /v2/alb/addIgnoredIngressStatusErrors | Ignore specific ingress status errors in ingress status reporting. |
| GET | /v2/alb/getAlb | View details of an ALB. |
| GET | /v2/alb/getAlbImages | List supported Ingress controller images. |
| GET | /v2/alb/getClusterAlbs | List all ALBs in a cluster. |
| GET | /v2/alb/getIngressClusterHealthcheck | Get the status of the in-cluster ALB health checker. |
| GET | /v2/alb/getStatus | Get the status of the ingress resources in a cluster. |
| GET | /v2/alb/listIgnoredIngressStatusErrors | List all ingress status errors that are ignored for the cluster. |
| DELETE | /v2/alb/removeIgnoredIngressStatusErrors | Unignore specific ingress status errors in ingress status reporting. |
| POST | /v2/alb/setIngressClusterHealthcheck | Set the in-cluster ingress health checker. |
| POST | /v2/alb/setIngressStatusState | Set the state of the ingress status. |
| POST | /v2/alb/updateAlb | Update ALBs in a cluster. |
| POST | /v2/alb/vpc/createAlb | Create a public or private ALB in a specified zone and VPC cluster. |
| POST | /v2/alb/vpc/disableAlb | Disable an ALB in your VPC cluster. |
| POST | /v2/alb/vpc/enableAlb | Enable an existing ALB in a VPC cluster. |
| POST | /v2/applyRBAC | Start applying IAM roles corresponding to your access to the cluster. |
| POST | /v2/applyRBACAndGetKubeconfig | Start applying IAM roles corresponding to your access to the cluster, then retrieve the cluster's kubeconfig file. |
| POST | /v2/autoUpdateMaster | Set the autoupdate status of the cluster master. |
| GET | /v2/classic/getCluster | Detailed cluster information. |
| GET | /v2/classic/getClusters | List the classic clusters that you have access to. |
| GET | /v2/classic/getPrivateServiceEnabled | Get if VRF and Service Endpoint is enabled for the given account in the selected region. |
| GET | /v2/classic/getVLANs | List available classic infrastructure VLANs for a zone. |
| GET | /v2/classic/getWorker | View details of a worker node for classic cluster. |
| GET | /v2/classic/getWorkerPool | View details of a worker pool for a classic cluster. |
| GET | /v2/classic/getWorkerPools | View details of a worker pool for a classic cluster. |
| GET | /v2/classic/getWorkers | View all workers for a classic cluster. |
| POST | /v2/createDedicatedHost | Create a dedicated host. |
| POST | /v2/createDedicatedHostPool | Create a dedicated host pool. |
| POST | /v2/disableDedicatedHostPlacement | Disable dedicated host placement. |
| POST | /v2/enableDedicatedHostPlacement | Enable dedicated host placement. |
| POST | /v2/enableKMS | Enables KMS in a cluster |
| GET | /v2/getCACert | Get the cluster's CA cert. |
| GET | /v2/getCRKs | List the root keys for a Key Management Service instance. |
| GET | /v2/getCluster | View details for a cluster. |
| GET | /v2/getClusterAddons | View details of the add-ons that are enabled in a cluster. |
| GET | /v2/getDedicatedHost | View details of a dedicated host. |
| GET | /v2/getDedicatedHostPool | View details of a dedicated host pool. |
| GET | /v2/getDedicatedHostPools | List the dedicated host pools. |
| GET | /v2/getDedicatedHosts | List the dedicated hosts. |
| GET | /v2/getFlavor | Get the details for a worker node flavor |
| GET | /v2/getFlavors | List available flavors types for a VPC zone (data center). |
| GET | /v2/getKMSInstances | Gets KMS instances tied to an account |
| GET | /v2/getKubeconfig | Get the cluster's kubeconfig file. |
| GET | /v2/getOperatingSystems | List supported operating systems. |
| GET | /v2/getQuota | View the quota for resources per region in the account. |
| GET | /v2/getRBACStatus | Get the RBACSync status. |
| GET | /v2/getWorker | View details of a worker node for cluster. |
| GET | /v2/getWorkerPool | View details of a worker pool for a cluster. |
| GET | /v2/getWorkerPools | List the worker pools in a cluster. |
| GET | /v2/getWorkers | View all workers for cluster. |
| GET | /v2/hasValidEntitlement | Validates user provided entitlement. |
| POST | /v2/rebalanceWorkerPool | Rebalance workers in a worker pool. |
| POST | /v2/refreshMaster | Refresh the Kubernetes master. |
| POST | /v2/removeDedicatedHost | Removes a dedicated host. |
| POST | /v2/removeDedicatedHostPool | Removes a dedicated host pool. |
| POST | /v2/removeWorker | Delete a worker node from a cluster. |
| POST | /v2/removeWorkerPool | Removes a worker pool. |
| POST | /v2/removeWorkerPoolZone | Remove a zone from a worker pool. |
| POST | /v2/resizeWorkerPool | Resize an existing worker pool. |
| POST | /v2/setWorkerPoolLabels | Set custom labels for a worker pool. |
| POST | /v2/setWorkerPoolOperatingSystem | Set the operating system of a worker pool. |
| POST | /v2/setWorkerPoolTaints | Set custom taints for a worker pool. |
| POST | /v2/vpc/createCluster | Create a VPC cluster. |
| POST | /v2/vpc/createWorkerPool | Create a worker pool for a VPC cluster. |
| POST | /v2/vpc/createWorkerPoolZone | Create a zone in the specified worker pool for a VPC cluster. |
| GET | /v2/vpc/getCluster | Get details of a VPC cluster. |
| GET | /v2/vpc/getClusters | List the VPC clusters that you have access to. |
| GET | /v2/vpc/getSubnets | View subnets for a given VPC. |
| GET | /v2/vpc/getVPC | View details of a VPC. |
| GET | /v2/vpc/getVPCs | View VPCs for the given provider. |
| GET | /v2/vpc/getWorker | View details of a worker node for VPC cluster. |
| GET | /v2/vpc/getWorkerPool | View details of a worker pool for a VPC cluster. |
| GET | /v2/vpc/getWorkerPools | List the worker pools in a VPC cluster. |
| GET | /v2/vpc/getWorkers | View all workers for VPC cluster. |
| GET | /v2/vpc/getZones | List available zones in a region. |
| POST | /v2/vpc/replaceWorker | Replace a worker node with a new worker node. |
| GET | /v2/cluster-health/getIssue | Get detailed information for one health issue (regional URL prefix). |
| GET | /v2/cluster-health/getIssues | List aggregated health issues for a cluster (regional URL prefix). |
| POST | /v2/disableImageSecurity | V2DisableImageSecurity |
| POST | /v2/enableImageSecurity | V2EnableImageSecurity |
| POST | /v2/disablePodSecurityPolicy | Deprecated: Disable the Pod Security Policy admission controller. |
| POST | /v2/enablePodSecurityPolicy | Deprecated: Enable the Pod Security Policy admission controller. |
| GET | /v2/getPodSecurity | View the Pod Security admission control configuration for a cluster. |
| GET | /v2/getPodSecurityPolicy | Deprecated: View the Pod Security Policy admission control configuration. |
| POST | /v2/removePodSecurity | Deprecated: Remove the Pod Security admission controller configuration for Kubernetes v1.24 clusters. |
| POST | /v2/setPodSecurity | Set the Pod Security admission controller configuration. |
| POST | /v2/disablePrivateServiceEndpoint | Disables a private service endpoint for a cluster. |
| POST | /v2/disablePublicServiceEndpoint | Disables a public service endpoint for a cluster. |
| POST | /v2/enablePrivateServiceEndpoint | Enables the private service endpoint for a cluster. |
| POST | /v2/enablePublicServiceEndpoint | Enables the public service endpoint for a cluster. |
| POST | /v2/enablePullSecret | Create an image pull secret to IBM Cloud Container Registry in the `default` namespace of the cluster. Note that this API method also requires the Administrator platform role to IBM Cloud Container Registry. |
| GET | /v2/getVersions | List available cluster versions. |
| POST | /v2/replaceWorker | Replace a worker node with a new worker node. |
| POST | /v2/updateMaster | Update the version of the Kubernetes cluster master node. |
| PUT | /v2/nlb-dns/configureHealthMonitor | Update the health monitoring configuration for the specified NLB subdomain in a cluster. |
| POST | /v2/nlb-dns/deleteSecret | Remove a secret from an NLB subdomain. |
| GET | /v2/nlb-dns/getHealthMonitorConfig | Get the health monitoring configuration for the specified NLB subdomain in a cluster. |
| GET | /v2/nlb-dns/getNlbDNSList | List registered NLB subdomains in a cluster. |
| GET | /v2/nlb-dns/getNlbDetails | Get the details for the specified NLB subdomain in a cluster. |
| GET | /v2/nlb-dns/getSatLocationSubdomain | Get the details for the specified subdomain in a Satellite location. |
| GET | /v2/nlb-dns/getSatLocationSubdomains | List registered NLB subdomains in a Satellite location. |
| POST | /v2/nlb-dns/regenerateCert | Regenerates cert for secret. |
| POST | /v2/nlb-dns/registerMSCDomains | Registers domains: c001, c002, c003, each tied to a corresponding IP and c000 tied to all of the IPs for the cluster. Also registers 1 cname, ce00, for the specified multishift cluster |
| POST | /v2/nlb-dns/vpc/createNlbDNS | Create a new NLB subdomain in a VPC cluster and associate a load balancer hostname with it. |
| POST | /v2/nlb-dns/vpc/removeLBHostname | Remove the load balancer hostname from the DNS record for an existing NLB subdomain. |
| POST | /v2/nlb-dns/vpc/replaceLBHostname | Update the DNS record for an NLB subdomain by replacing the load balancer hostname. |
| GET | /v2/rotateClusterCOSKey | Do not use it as this endpoint is not supported in the long term |
| POST | /v2/satellite/createCluster | Create an IBM Cloud Satellite cluster. |
| POST | /v2/satellite/createWorkerPool | Create a worker pool for an IBM Cloud Satellite cluster. |
| POST | /v2/satellite/createWorkerPoolZone | Create a zone in the specified worker pool for an IBM Cloud Satellite cluster. |
| GET | /v2/satellite/getClusters | List the IBM Cloud Satellite clusters that you have access to. |
| POST | /v2/satellite/createClusterRemoteLocation | Create an IBM Cloud Satellite cluster in a location that does not belong to your account. |
| GET | /v2/satellite/getServiceClusters | List the clusters in an IBM Cloud Satellite location that are associated with a Satellite-enabled service instance. |
| POST | /v2/satellite/createController | Create an IBM Cloud Satellite location. |
| GET | /v2/satellite/getController | Get the details for an IBM Cloud Satellite location. |
| GET | /v2/satellite/getControllers | List the IBM Cloud Satellite locations that you have access to. |
| POST | /v2/satellite/removeController | Remove an IBM Cloud Satellite Location. |
| POST | /v2/satellite/hostqueue/createAssignment | Assign a host to an IBM Cloud Satellite location or cluster. |
| POST | /v2/satellite/hostqueue/createRegistrationScript | Attach a host to an IBM Cloud Satellite location. |
| GET | /v2/satellite/hostqueue/getHosts | List the hosts in your IBM Cloud Satellite location. |
| POST | /v2/satellite/hostqueue/removeHost | Remove a host from an IBM Cloud Satellite location or cluster. |
| POST | /v2/satellite/hostqueue/updateHost | Update a host in your IBM Cloud Satellite location. |
| POST | /v2/storage/createAttachment | createAttachment |
| POST | /v2/storage/deleteAttachment | Detach volume from given worker. |
| GET | /v2/storage/getAttachment | getAttachment |
| GET | /v2/storage/getAttachments | getAttachments |
| GET | /v2/storage/getVolume | Get the details of a storage volume. |
| GET | /v2/storage/getVolumes | List storage volumes for a cluster or for the account if no cluster is provided. |
| PATCH | /v2/storage/satellite/ackDesiredStorageConfigCapacity | Acknowledge the request to expand storage capacity. |
| POST | /v2/storage/satellite/createAssignment | Create an assignment using a Satellite storage configuration for the cluster group(s). |
| POST | /v2/storage/satellite/createAssignmentByCluster | Create an assignment using a Satellite storage configuration for a Satellite cluster or service cluster. |
| POST | /v2/storage/satellite/createStorageConfiguration | Deprecated. To create a Satellite storage configuration, you can use /v2/storage/satellite/createStorageConfigurationByController API instead. |
| POST | /v2/storage/satellite/createStorageConfigurationByController | Create a Satellite storage configuration |
| PATCH | /v2/storage/satellite/expandDesiredStorageConfigCapacity | Expand the capacity of a storage request. |
| GET | /v2/storage/satellite/getAssignedStorageConfigs | List Satellite storage configurations assigned to a Satellite cluster or service cluster. |
| GET | /v2/storage/satellite/getAssignment | View details of an assignment. |
| GET | /v2/storage/satellite/getAssignmentByName | Deprecated. To view details of an assignment, you can use /v2/storage/satellite/getAssignment API instead. |
| GET | /v2/storage/satellite/getAssignments | List storage assignments in the IBM Cloud account. |
| GET | /v2/storage/satellite/getAssignmentsByClusterID | List storage assignments created for a Satellite cluster or service cluster. |
| GET | /v2/storage/satellite/getAssignmentsByConfig | List storage assignments by configuration name or UUID. |
| GET | /v2/storage/satellite/getAssignmentsByController | List storage assignments in a Satellite location. |
| GET | /v2/storage/satellite/getAvailableStorageClasses | List and filter available storage classes from assigned Satellite storage configurations on a Satellite cluster or service cluster. |
| GET | /v2/storage/satellite/getDesiredStorageConfig | List Storage requests on a cluster. |
| GET | /v2/storage/satellite/getStorageConfiguration | View details of a Satellite storage configuration. |
| GET | /v2/storage/satellite/getStorageConfigurations | List Satellite storage configurations. |
| GET | /v2/storage/satellite/getStorageConfigurationsByController | List Satellite storage configurations in a Satellite location. |
| GET | /v2/storage/satellite/getStorageTemplate | View the details of a Satellite storage template. |
| GET | /v2/storage/satellite/getStorageTemplateChangelog | View the change log details of Satellite storage templates. |
| GET | /v2/storage/satellite/getStorageTemplates | List Satellite storage templates. |
| DELETE | /v2/storage/satellite/removeAssignment | Remove an assignment. |
| DELETE | /v2/storage/satellite/removeDesiredStorageConfig | Delete a storage request |
| DELETE | /v2/storage/satellite/removeStorageConfiguration | Remove a Satellite storage configuration. |
| PATCH | /v2/storage/satellite/setAssignmentAutoupgrade | Enable or disable automatic upgrades for an existing storage assignment(s). |
| POST | /v2/storage/satellite/setDesiredStorageConfig | Create a storage request on a cluster |
| PATCH | /v2/storage/satellite/updateAssignment | Update an assignment. |
| POST | /v2/storage/satellite/updateStorageConfiguration | Deprecated. To update a Satellite storage configuration, you can use /v2/storage/satellite/updateStorageConfigurationByController instead. |
| POST | /v2/storage/satellite/updateStorageConfigurationByController | Update a Satellite storage configuration. |
| PATCH | /v2/storage/satellite/updateStorageConfigurationRevision | Update a Satellite storage configuration to use the latest template revision. |
| PATCH | /v2/storage/satellite/ackDesiredStorageConfigCapacity | Acknowledge the request to expand storage capacity. |
| POST | /v2/storage/satellite/createAssignment | Create an assignment using a Satellite storage configuration for the cluster group(s). |
| POST | /v2/storage/satellite/createAssignmentByCluster | Create an assignment using a Satellite storage configuration for a Satellite cluster or service cluster. |
| POST | /v2/storage/satellite/createStorageConfiguration | Deprecated. To create a Satellite storage configuration, you can use /v2/storage/satellite/createStorageConfigurationByController API instead. |
| POST | /v2/storage/satellite/createStorageConfigurationByController | Create a Satellite storage configuration |
| PATCH | /v2/storage/satellite/expandDesiredStorageConfigCapacity | Expand the capacity of a storage request. |
| GET | /v2/storage/satellite/getAssignedStorageConfigs | List Satellite storage configurations assigned to a Satellite cluster or service cluster. |
| GET | /v2/storage/satellite/getAssignment | View details of an assignment. |
| GET | /v2/storage/satellite/getAssignmentByName | Deprecated. To view details of an assignment, you can use /v2/storage/satellite/getAssignment API instead. |
| GET | /v2/storage/satellite/getAssignments | List storage assignments in the IBM Cloud account. |
| GET | /v2/storage/satellite/getAssignmentsByClusterID | List storage assignments created for a Satellite cluster or service cluster. |
| GET | /v2/storage/satellite/getAssignmentsByConfig | List storage assignments by configuration name or UUID. |
| GET | /v2/storage/satellite/getAssignmentsByController | List storage assignments in a Satellite location. |
| GET | /v2/storage/satellite/getAvailableStorageClasses | List and filter available storage classes from assigned Satellite storage configurations on a Satellite cluster or service cluster. |
| GET | /v2/storage/satellite/getDesiredStorageConfig | List Storage requests on a cluster. |
| GET | /v2/storage/satellite/getStorageConfiguration | View details of a Satellite storage configuration. |
| GET | /v2/storage/satellite/getStorageConfigurations | List Satellite storage configurations. |
| GET | /v2/storage/satellite/getStorageConfigurationsByController | List Satellite storage configurations in a Satellite location. |
| GET | /v2/storage/satellite/getStorageTemplate | View the details of a Satellite storage template. |
| GET | /v2/storage/satellite/getStorageTemplateChangelog | View the change log details of Satellite storage templates. |
| GET | /v2/storage/satellite/getStorageTemplates | List Satellite storage templates. |
| DELETE | /v2/storage/satellite/removeAssignment | Remove an assignment. |
| DELETE | /v2/storage/satellite/removeDesiredStorageConfig | Delete a storage request |
| DELETE | /v2/storage/satellite/removeStorageConfiguration | Remove a Satellite storage configuration. |
| PATCH | /v2/storage/satellite/setAssignmentAutoupgrade | Enable or disable automatic upgrades for an existing storage assignment(s). |
| POST | /v2/storage/satellite/setDesiredStorageConfig | Create a storage request on a cluster |
| PATCH | /v2/storage/satellite/updateAssignment | Update an assignment. |
| POST | /v2/storage/satellite/updateStorageConfiguration | Deprecated. To update a Satellite storage configuration, you can use /v2/storage/satellite/updateStorageConfigurationByController instead. |
| POST | /v2/storage/satellite/updateStorageConfigurationByController | Update a Satellite storage configuration. |
| PATCH | /v2/storage/satellite/updateStorageConfigurationRevision | Update a Satellite storage configuration to use the latest template revision. |