{ "openapi": "3.0.0", "info": { "description": "## Introduction\n\nDeploy 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 documentation](https://cloud.ibm.com/docs/containers?topic=containers-cs_api_install#kube_api).\n\n## Before you begin\n\n- Make sure that you have access to a [paid IBM Cloud account](https://cloud.ibm.com/registration).\n- [Choose a strategy](https://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.\n\n## Charges\n\nWith 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-faqs#charges)\n\n## Authentication\n\nThe 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. \n\n## Authorization\n\nTo 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 cluster](https://cloud.ibm.com/docs/containers?topic=containers-iam-platform-access-roles#cluster-create-permissions).\n\nBeginning with version 4.0.0, the Node SDK returns a Promise for all methods when a callback isn't specified.\n\nThe 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.\n\n## IAM and Activity Tracker actions by API method\n\nFor a list of the IBM Cloud Identity and Access Management (IAM) action and Activity Tracker events by API method, see the [product documentation](https://cloud.ibm.com/docs/containers?topic=containers-iam-platform-access-roles).\n\n## API endpoint\n\nUse the following API endpoint for all API requests: \n\n```sh\nhttps://containers.cloud.ibm.com/global\n```\n\n## Versioning\n\nThe 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. \n\nFor information about the API versions, see [About the API](https://cloud.ibm.com/docs/containers?topic=containers-cs_api_install#api_about). \n\n## Error handling\n\nThis 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.\n\n| HTTP error code | Description | Recovery |\n|-----------------|-------------|----------|\n| `200` | Success | The request was successful. |\n| `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. |\n| `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.\t|\n| `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. |\n| `404` | Not Found | The requested resource could not be found. |\n| `408` | Request Timeout | The connection to the server timed out. Wait a few minutes, then try again. |\n| `409` | Conflict | The cluster or an associated cluster resource with the same name or ID already exists. |\n| `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. |", "title": "Kubernetes Service API", "version": "1.1", "x-github": "https://github.ibm.com/cloud-api-docs/kubernetes", "x-github-issues": "https://github.ibm.com/cloud-api-docs/kubernetes/issues/new", "x-last-updated": "2026-03-27" }, "paths": { "/ingress/v2/clusters/{idOrName}/albs/{albID}/autoscale": { "get": { "description": "Get the autoscaling configuration for an ALB. The autoscaling feature is enabled when there is a configuration set for the ALB. If the configuration is missing, the feature is disabled.", "tags": [ "ingress-autoscale" ], "summary": "Get the autoscaling configuration for an ALB.", "operationId": "V2GetAutoScale", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the ALB that you want details for. To list the IDs for the ALBs in a cluster, use the `GET /clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "name": "alb_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The autoscaling configuration for your ALB is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. No autoscale configuration set for this cluster and ALB, or the specified cluster or ALB could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An autoscaling configuration is returned.", "events": [ { "name": "cluster-alb-autoscale.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To call this endpoint, you must have the Viewer platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/clusters/{idOrName}/albs/{albID}/autoscale\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "put": { "description": "Set an autoscaling configuration for an ALB. Setting a configuration enables the autoscaling feature. You can also use this endpoint to change the autoscaling configuration.", "tags": [ "ingress-autoscale" ], "summary": "Set the autoscaling configuration for an ALB.", "operationId": "V2SetAutoScale", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the ALB that you want details for. To list the IDs for the ALBs in a cluster, use the `GET /clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "name": "alb_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoscaleDetails" } } }, "description": "New autoscale configuration to be set.", "required": true }, "x-codegen-request-body-name": "autoscaleDetails", "responses": { "200": { "description": "Ok. The provided autoscaling configuration for your ALB is set.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The the specified cluster or ALB could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An autoscaling configuration is created or updated.", "events": [ { "name": "cluster-alb-autoscale.set" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "You must have the Editor platform role for the Kubernetes Service in IAM to call this endpoint." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/ingress/v2/clusters/{idOrName}/albs/{albID}/autoscale\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"config\": {\n", " \"cpuAverageUtilization\": 1,\n", " \"customMetrics\": \"example-value\",\n", " \"maxReplicas\": 1,\n", " \"minReplicas\": 1\n", " }\n", "}'\n" ] } ] } ] } } }, "delete": { "description": "Delete an autoscaling configuration for the ALB. Deleting the configuration disables autoscaling.", "tags": [ "ingress-autoscale" ], "summary": "Delete the autoscaling configuration for an ALB.", "operationId": "V2UnsetAutoScale", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the ALB that you want details for. To list the IDs for the ALBs in a cluster, use the `GET /clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "name": "alb_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. Autoscale config was unset successfully.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. No autoscaling configuration set for this cluster and ALB, or the specified cluster or ALB could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An autoscaling configuration is deleted.", "events": [ { "name": "cluster-alb-autoscale.unset" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "You must have the Editor platform role for the Kubernetes Service in IAM to call this endpoint." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/ingress/v2/clusters/{idOrName}/albs/{albID}/autoscale\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/ingress/v2/dns/createDomain": { "post": { "description": "Create an Ingress domain for a cluster.", "tags": [ "ingress-domain" ], "summary": "Create an Ingress domain for a cluster.", "operationId": "CreateDomain", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDomainReq" } } }, "description": "Input parameter to create a domain.", "required": true }, "x-codegen-request-body-name": "domainConfig", "responses": { "201": { "description": "Created. The domain is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedNlbVPCConfig" }, "example": { "certProvider": "vpc-gen2", "cluster": "example-value", "crn": "example-value", "dnsType": "example-value", "isDefault": false, "lbHostname": "my-cluster", "nlbIPArray": [ "example-value" ], "nlbSubdomain": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/dns/createDomain\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"crn\": \"example-value\",\n", " \"hostname\": \"my-cluster\",\n", " \"ips\": [\n", " \"example-value\"\n", " ],\n", " \"isDefault\": false,\n", " \"provider\": \"vpc-gen2\",\n", " \"secretNamespace\": \"my-cluster\",\n", " \"zoneID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/dns/deleteCredential": { "post": { "description": "Deprecated: Delete the registered external provider credential for a cluster.", "tags": [ "ingress-domain" ], "summary": "Deprecated: Delete external domain provider credential.", "operationId": "DeleteCredential", "deprecated": true, "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The credential was successfully fetched.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/dns/deleteCredential?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/ingress/v2/dns/deleteDomain": { "post": { "description": "Delete a non-default Ingress domain for a cluster.", "tags": [ "ingress-domain" ], "summary": "Delete a non-default Ingress domain for a cluster.", "operationId": "DeleteDomain", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDomainReq" } } }, "description": "Input parameter to delete a domain.", "required": true }, "x-codegen-request-body-name": "domainConfig", "responses": { "200": { "description": "Ok. The domain is deleted.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/dns/deleteDomain\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"subdomain\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/dns/getCredential": { "get": { "description": "Deprecated: Get metadata for the registered external provider credential for a cluster.", "tags": [ "ingress-domain" ], "summary": "Deprecated: Get external domain provider credential metadata.", "operationId": "GetCredential", "deprecated": true, "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The credential was successfully fetched.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCredentials" }, "example": { "cluster": "example-value", "credID": "example-id-123", "expiresOn": "example-value", "lastUpdatedTimestamp": "example-value", "provider": "vpc-gen2" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/dns/getCredential?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/ingress/v2/dns/replaceDefaultSubdomain": { "post": { "description": "Replace the default Ingress domain for a cluster and refresh the related cluster components.", "tags": [ "ingress-domain" ], "summary": "Replace the existing default Ingress domain for a cluster.", "operationId": "ReplaceDefaultSubdomain", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceDefaultSubdomainReq" } } }, "description": "Input parameter to replace default domain.", "required": true }, "x-codegen-request-body-name": "domainConfig", "responses": { "200": { "description": "Ok. The default domain is replaced.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/dns/replaceDefaultSubdomain\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"subdomain\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/dns/setCredential": { "post": { "description": "Deprecated: Register a credential for external domain provider for use in ingress domain commands.", "tags": [ "ingress-domain" ], "summary": "Deprecated: Set external domain provider credential.", "operationId": "SetCredential", "deprecated": true, "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialReq" } } }, "description": "Input parameter to register an external domain provider credential.", "required": true }, "x-codegen-request-body-name": "domainConfig", "responses": { "201": { "description": "Created. The credential was successfully registered.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/dns/setCredential\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"akamai_credentials\": {\n", " \"access_token\": \"example-value\",\n", " \"client_secret\": \"example-value\",\n", " \"client_token\": \"example-value\",\n", " \"host\": \"example-value\",\n", " \"zone\": \"us-south-1\"\n", " },\n", " \"cloudflare_credentials\": {\n", " \"token\": \"example-value\",\n", " \"zone_id\": \"example-id-123\"\n", " },\n", " \"cluster\": \"example-value\",\n", " \"provider\": \"vpc-gen2\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/dns/updateDomain": { "post": { "description": "Update an Ingress domain with the specified IPs or hostnames.", "tags": [ "ingress-domain" ], "summary": "Update an Ingress domain for a cluster.", "operationId": "UpdateDomain", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDomainReq" } } }, "description": "Input parameter to update a domain.", "required": true }, "x-codegen-request-body-name": "domainConfig", "responses": { "200": { "description": "Ok. The domain is updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/dns/updateDomain\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"domain\": \"example-value\",\n", " \"hostname\": \"my-cluster\",\n", " \"ips\": [\n", " \"example-value\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/load-balancer/configuration": { "get": { "description": "Get settings for load balancers that expose Ingress ALBs in your cluster.", "tags": [ "ingress-loadbalancer" ], "summary": "Get configuration of load balancers for Ingress ALBs.", "operationId": "GetLBConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Type of load balancer configuration to return. Possible options are `public` and `private`.", "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The load balancer configuration for the specified type is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LBConfig" }, "example": { "backend": { "private": "example-value", "public": "example-value" }, "cluster": "example-value", "proxyProtocol": { "cidr": [ "example-id-123" ], "enable": true, "headerTimeout": 1 }, "type": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/load-balancer/configuration?cluster=example-value&type=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "patch": { "description": "Configure settings for load balancers that expose Ingress ALBs in your cluster. After you use this API to set load balancer options, the existing load balancers are deleted and recreated, which can cause service disruptions. Two unused IP addresses for each new load balancer must be available in each subnet during the load balancer recreation. To configure load balancers that expose only your public ALBs or only your private ALBs, specify `public` or `private` for the `type` field in the request body. If you leave the `type` field empty, the configuration is applied to all load balancers that expose ALBs in the cluster.\n\nAvailable features:\n + `proxyProtocol`:\n + Limitations:\n + This feature is supported only for VPC Gen 2 clusters that run Kubernetes version 1.18 or later.\n + This feature is cluster-level, therefore `type` field of the request must be empty.\n + Configuration:\n + `enable`: Set to `true` to enable or `false` to disable the PROXY protocol for the ALB load balancers. The PROXY protocol enables load balancers to pass client connection information that is contained in headers on the client request, including the client IP address, the proxy server IP address, and both port numbers, to ALBs.\n + `headerTimeout`: The timeout value, in seconds, for the load balancer to receive the PROXY protocol headers that contain the client connection information. This option has effect only on ALBs running the Kubernetes Ingress image. Default: `5`\n + `cidr`: Load balancer CIDRs from which ALBs process information in PROXY protocol headers. If requests that contain PROXY headers originate from load balancers in other IP ranges, the information in the headers is not process by the ALB. This option has effect only on ALBs running the Kubernetes Ingress image. Default: `0.0.0.0/0`", "tags": [ "ingress-loadbalancer" ], "summary": "Update the configuration of load balancers for Ingress ALBs.", "operationId": "PatchLBConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LBConfig" } } }, "description": "In the request body, specify the desired configuration of load balancer features you want to change.", "required": true }, "x-codegen-request-body-name": "LBConfig", "responses": { "202": { "description": "Load-balancer configuration submitted and update started.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "423": { "description": "Locked. The previous load-balancer configuration is still in progress.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/ingress/v2/load-balancer/configuration\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"backend\": {\n", " \"private\": \"example-value\",\n", " \"public\": \"example-value\"\n", " },\n", " \"cluster\": \"example-value\",\n", " \"proxyProtocol\": {\n", " \"cidr\": [\n", " \"example-id-123\"\n", " ],\n", " \"enable\": true,\n", " \"headerTimeout\": 1\n", " },\n", " \"type\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/addField": { "post": { "description": "Add fields to an Ingress secret with a secret stored in IBM Cloud Secrets Manager.", "tags": [ "ingress-secret" ], "summary": "Add fields to an Ingress secret with a secret stored in IBM Cloud Secrets Man...", "operationId": "AddSecretField", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConfig" } } }, "description": "Input parameter to add a secret field.", "required": true }, "x-codegen-request-body-name": "secretConfig", "responses": { "201": { "description": "Updated. The fields were successfully added to the secret in the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "example": { "cluster": "example-value", "crn": "example-value", "domain": "example-value", "domains": [ "example-value" ], "expiresOn": "example-value", "fields": [ { "crn": "example-value", "expiresOn": "example-value", "lastUpdatedTimestamp": "example-value", "name": "my-cluster", "secretType": "example-value" } ], "lastUpdatedTimestamp": "example-value", "name": "my-cluster" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/addField\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"add\": [\n", " {\n", " \"append_prefix\": false,\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\"\n", " }\n", " ],\n", " \"cluster\": \"example-value\",\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\",\n", " \"namespace\": \"my-cluster\",\n", " \"remove\": [\n", " {\n", " \"name\": \"my-cluster\"\n", " }\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/createSecret": { "post": { "description": "Create an Ingress secret with a secret stored in IBM Cloud Secrets Manager.", "tags": [ "ingress-secret" ], "summary": "Create an Ingress secret with a secret stored in IBM Cloud Secrets Manager.", "operationId": "CreateSecret", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConfig" } } }, "description": "Input parameter to add a secret.", "required": true }, "x-codegen-request-body-name": "secretConfig", "responses": { "201": { "description": "Created. The secret was successfully created in the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "example": { "cluster": "example-value", "crn": "example-value", "domain": "example-value", "domains": [ "example-value" ], "expiresOn": "example-value", "fields": [ { "crn": "example-value", "expiresOn": "example-value", "lastUpdatedTimestamp": "example-value", "name": "my-cluster", "secretType": "example-value" } ], "lastUpdatedTimestamp": "example-value", "name": "my-cluster" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/createSecret\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"add\": [\n", " {\n", " \"append_prefix\": false,\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\"\n", " }\n", " ],\n", " \"cluster\": \"example-value\",\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\",\n", " \"namespace\": \"my-cluster\",\n", " \"persistence\": false,\n", " \"type\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/deleteSecret": { "post": { "description": "Delete an Ingress secret from the cluster.", "tags": [ "ingress-secret" ], "summary": "Delete an Ingress secret from the cluster.", "operationId": "DeleteIngressSecret", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConfig" } } }, "description": "Input parameter to add a secret.", "required": true }, "x-codegen-request-body-name": "secretConfig", "responses": { "204": { "description": "Deleted. The secret was successfully deleted from the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/deleteSecret\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"delete_cert\": false,\n", " \"name\": \"my-cluster\",\n", " \"namespace\": \"my-cluster\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/getInstance": { "get": { "description": "View an IBM Cloud Secrets Manager instance registered to the cluster.", "tags": [ "ingress-secret-instance" ], "summary": "View an IBM Cloud Secrets Manager instance registered to the cluster.", "operationId": "GetSecretInstance", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want information about. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name of the instance that you want information about. To list the instances that you have access to, use the `GET /ingress/v2/secret/getInstances` API or run `ibmcloud ks ingress secret instance ls`.", "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the secret is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" }, "example": { "callbackChannel": "example-value", "cluster": "example-value", "crn": "example-value", "isDefault": false, "name": "my-cluster", "secretGroupID": "example-id-123", "secretGroupName": "my-cluster", "status": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/secret/getInstance?cluster=example-value&name=my-cluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/ingress/v2/secret/getInstances": { "get": { "description": "View IBM Cloud Secrets Manager instances registered to the cluster.", "tags": [ "ingress-secret-instance" ], "summary": "View IBM Cloud Secrets Manager instances registered to the cluster.", "operationId": "GetSecretInstances", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want information about. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "To view previously deleted instances, pass `true`.", "name": "show_deleted", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The list of available Ingress secrets is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instances" }, "example": [ { "callbackChannel": "example-value", "cluster": "example-value", "crn": "example-value", "isDefault": false, "name": "my-cluster", "secretGroupID": "example-id-123", "secretGroupName": "my-cluster", "status": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/secret/getInstances?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/ingress/v2/secret/getSecret": { "get": { "description": "View Ingress secret details.", "tags": [ "ingress-secret" ], "summary": "View Ingress secret details.", "operationId": "GetSecret", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want information about. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name of the secret that you want information about. To list the secrets that you have access to, use the `GET /ingress/v2/secret/getSecrets` API or run `ibmcloud ks ingress secret ls`.", "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The namespace of the secret that you want information about. To list the secrets that you have access to, use the `GET /ingress/v2/secret/getSecrets` API or run `ibmcloud ks ingress secret ls`.", "name": "namespace", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the secret is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "example": { "cluster": "example-value", "crn": "example-value", "domain": "example-value", "domains": [ "example-value" ], "expiresOn": "example-value", "fields": [ { "crn": "example-value", "expiresOn": "example-value", "lastUpdatedTimestamp": "example-value", "name": "my-cluster", "secretType": "example-value" } ], "lastUpdatedTimestamp": "example-value", "name": "my-cluster" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/secret/getSecret?cluster=example-value&name=my-cluster&namespace=my-cluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/ingress/v2/secret/getSecrets": { "get": { "description": "View Ingress secrets for a cluster.", "tags": [ "ingress-secret" ], "summary": "View Ingress secrets for a cluster.", "operationId": "GetSecrets", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want information about. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "To view previously deleted secrets, pass `true`.", "name": "show_deleted", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The list of available Ingress secrets is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secrets" }, "example": [ { "cluster": "example-value", "crn": "example-value", "domain": "example-value", "domains": [ "example-value" ], "expiresOn": "example-value", "fields": [ { "crn": "example-value", "expiresOn": "example-value", "lastUpdatedTimestamp": "example-value", "name": "my-cluster", "secretType": "example-value" } ], "lastUpdatedTimestamp": "example-value", "name": "my-cluster" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/secret/getSecrets?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/ingress/v2/secret/registerInstance": { "post": { "description": "Register an IBM Cloud Secrets Manager instance to the cluster.", "tags": [ "ingress-secret-instance" ], "summary": "Register an IBM Cloud Secrets Manager instance to the cluster.", "operationId": "RegisterSecretInstance", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterConfig" } } }, "description": "Input parameter to register an instance.", "required": true }, "x-codegen-request-body-name": "instanceConfig", "responses": { "200": { "description": "Created. The instance was successfully registered to the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" }, "example": { "callbackChannel": "example-value", "cluster": "example-value", "crn": "example-value", "isDefault": false, "name": "my-cluster", "secretGroupID": "example-id-123", "secretGroupName": "my-cluster", "status": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/registerInstance\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"crn\": \"example-value\",\n", " \"isDefault\": false,\n", " \"secretGroupID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/removeField": { "post": { "description": "Remove fields from an Ingress secret with a secret stored in IBM Cloud Secrets Manager.", "tags": [ "ingress-secret" ], "summary": "Remove fields from an Ingress secret with a secret stored in IBM Cloud Secret...", "operationId": "RemoveSecretField", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConfig" } } }, "description": "Remove input parameter to remove a secret field.", "required": true }, "x-codegen-request-body-name": "secretConfig", "responses": { "200": { "description": "Updated. The fields were successfully removed from the secret in the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "example": { "cluster": "example-value", "crn": "example-value", "domain": "example-value", "domains": [ "example-value" ], "expiresOn": "example-value", "fields": [ { "crn": "example-value", "expiresOn": "example-value", "lastUpdatedTimestamp": "example-value", "name": "my-cluster", "secretType": "example-value" } ], "lastUpdatedTimestamp": "example-value", "name": "my-cluster" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/removeField\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"add\": [\n", " {\n", " \"append_prefix\": false,\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\"\n", " }\n", " ],\n", " \"cluster\": \"example-value\",\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\",\n", " \"namespace\": \"my-cluster\",\n", " \"remove\": [\n", " {\n", " \"name\": \"my-cluster\"\n", " }\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/unregisterInstance": { "post": { "description": "Unregister an IBM Cloud Secrets Manager instance from the cluster.", "tags": [ "ingress-secret-instance" ], "summary": "Unregister an IBM Cloud Secrets Manager instance from the cluster.", "operationId": "UnregisterSecretInstance", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConfig" } } }, "description": "Input parameter to unregister an instance.", "required": true }, "x-codegen-request-body-name": "instanceConfig", "responses": { "200": { "description": "Deleted. The secret was successfully deleted from the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/unregisterInstance\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"delete_cert\": false,\n", " \"name\": \"my-cluster\",\n", " \"namespace\": \"my-cluster\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/updateInstance": { "post": { "description": "Update an IBM Cloud Secrets Manager instance registration configuration to the cluster.", "tags": [ "ingress-secret-instance" ], "summary": "Update an IBM Cloud Secrets Manager instance registration configuration to th...", "operationId": "UpdateSecretInstance", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceUpdateConfig" } } }, "description": "Input parameter to update instance registration.", "required": true }, "x-codegen-request-body-name": "instanceConfig", "responses": { "200": { "description": "Update. The instance was successfully updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified instance could not be found. To list the registered instances that you have access to, use the `GET /v2/secret/getInstances` API or run `ibmcloud ks ingress secret instance ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/updateInstance\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"isDefault\": false,\n", " \"name\": \"my-cluster\",\n", " \"secretGroupID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/secret/updateSecret": { "post": { "description": "Update an Ingress secret with a secret stored in IBM Cloud Secrets Manager.", "tags": [ "ingress-secret" ], "summary": "Update an Ingress secret with a secret stored in IBM Cloud Secrets Manager.", "operationId": "UpdateSecret", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConfig" } } }, "description": "Input parameter to add a secret.", "required": true }, "x-codegen-request-body-name": "secretConfig", "responses": { "201": { "description": "Created. The secret was successfully created in the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Secret" }, "example": { "cluster": "example-value", "crn": "example-value", "domain": "example-value", "domains": [ "example-value" ], "expiresOn": "example-value", "fields": [ { "crn": "example-value", "expiresOn": "example-value", "lastUpdatedTimestamp": "example-value", "name": "my-cluster", "secretType": "example-value" } ], "lastUpdatedTimestamp": "example-value", "name": "my-cluster" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/ingress/v2/secret/updateSecret\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"add\": [\n", " {\n", " \"append_prefix\": false,\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\"\n", " }\n", " ],\n", " \"cluster\": \"example-value\",\n", " \"crn\": \"example-value\",\n", " \"name\": \"my-cluster\",\n", " \"namespace\": \"my-cluster\",\n", " \"remove\": [\n", " {\n", " \"name\": \"my-cluster\"\n", " }\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/ingress/v2/security/port80": { "get": { "description": "Get the configuration of a cluster's port 80 security settings.", "tags": [ "port80" ], "summary": "Get the configuration of a cluster's port 80 security settings.", "operationId": "GetPort80", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The port 80 configuration for the specified cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Port80Config" }, "example": { "cluster": "example-value", "state": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/ingress/v2/security/port80?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "patch": { "description": "Enable port 80 on a Kubernetes or Red Hat OpenShift cluster. For clusters created after December 1, 2025, port 80 belonging to the default OpenShift router and Kubernetes ingress is disabled by default. Configure this setting to enable the port.", "tags": [ "port80" ], "summary": "Enable port 80 on the cluster.", "operationId": "UpdatePort80", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Port80Config" } } }, "description": "Specify the security setting for port 80.", "required": true }, "x-codegen-request-body-name": "Port80Config", "responses": { "200": { "description": "Port 80 security configuration submitted and update started.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/ingress/v2/security/port80\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"state\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/network/v2/oauth-access-type/{idOrName}": { "get": { "tags": [ "oauth-access-type" ], "summary": "Get the OAuth access type for a VPC cluster.", "operationId": "GetOauthAccessType", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The OAuth access type for the specified cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OauthAccessTypeJSON" }, "example": { "oauth_access_type": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Get the OAuth access type for a cluster.", "events": [ { "name": "oauth-access-type.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/network/v2/oauth-access-type/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/network/v2/oauth-access-type/{idOrName}/set": { "post": { "tags": [ "oauth-access-type" ], "summary": "Set the OAuth access type for a VPC cluster.", "operationId": "SetOauthAccessType", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OauthAccessTypeJSON" } } }, "description": "Specify the OAuth access type that you want to use. Accepted values are `vpegw` or `legacy`.", "required": true }, "x-codegen-request-body-name": "oauth-access-type", "responses": { "202": { "description": "Accepted. The request to set the OAuth access type was successful.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "The OAuth access type you specified is not supported.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster's OAuth access type is updated or configured", "events": [ { "name": "oauth-access-type.set" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To get the action, the user must have the Editor platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/network/v2/oauth-access-type/{idOrName}/set\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"oauth_access_type\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/network/v2/outbound-traffic-protection": { "post": { "tags": [ "outbound-traffic-protection" ], "summary": "Modify the outbound traffic protection policy for a VPC cluster using Secure ...", "operationId": "OutboundTrafficProtectionOperation", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundTrafficProtectionRequest" } } }, "description": "Specify the outbound traffic protection policy for your cluster. Available options are `enable-outbound-protection` and `disable-outbound-protection`.", "required": true }, "x-codegen-request-body-name": "outboundTrafficProtectionOperation", "responses": { "202": { "description": "Accepted. The request to set the outbound traffic protection policy was successful.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The query parameters are either incomplete or in the wrong format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/network/v2/outbound-traffic-protection\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"operation\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/network/v2/satellite-acl/{idOrName}": { "get": { "description": "List all subnets in the Satellite allowlist for a Satellite cluster's service endpoint. This list includes subnets that you manually added by using the `PATCH /network/v2/satellite-acl/{idOrName}/add` API and subnets that are automatically added and managed by IBM, such as worker node subnets.", "tags": [ "acl" ], "summary": "Get a Satellite cluster's service endpoint allowlist.", "operationId": "GetSatelliteClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The allowlist for the Satellite cluster's service endpoint is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SatelliteACLResponse" }, "example": { "actualCSEACLList": [ "example-value" ], "desiredCSEACLList": [ "example-value" ] } } } }, "400": { "description": "Bad request. Satellite Service Endpoint Allowlist feature is disabled on the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified Satellite cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/network/v2/satellite-acl/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "delete": { "description": "Disable the subnet allowlist feature for a Satellite cluster's service endpoint. After you disable this feature, authorized requests to your Satellite cluster master through the Satellite cluster's service endpoint can originate from any subnet.", "tags": [ "acl" ], "summary": "Disable the subnet allowlist for a Satellite cluster's service endpoint.", "operationId": "DisableSatelliteClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted. The request to disable the Satellite allowlist feature for your Satellite cluster's service endpoint was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified Satellite cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/network/v2/satellite-acl/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/network/v2/satellite-acl/{idOrName}/add": { "patch": { "description": "When you add a subnet to a disabled Satellite cluster's service endpoint allowlist, the Satellite allowlist is automatically enabled. Only authorized requests to your Satellite cluster master that originate from subnets in this allowlist are permitted through the Satellite cluster's service endpoint. The subnets for your Satellite cluster's worker nodes must be added to this allowlist for the worker nodes to communicate with the master through the Satellite service endpoint.", "tags": [ "acl" ], "summary": "Add subnets to a Satellite cluster's service endpoint allowlist.", "operationId": "AddSatelliteClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/csePatchACL" } } }, "description": "The list of subnets to add to the Satellite cluster's service endpoint allowlist.", "required": true }, "x-codegen-request-body-name": "csePatchACL", "responses": { "201": { "description": "Created. The subnets are successfully added to the Satellite cluster's service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "204": { "description": "No content. The subnets are successfully added to the Satellite cluster's service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified Satellite cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/network/v2/satellite-acl/{idOrName}/add\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"aclList\": [\n", " \"example-value\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/network/v2/satellite-acl/{idOrName}/enable": { "post": { "description": "Enable the subnet allowlist feature for a Satellite cluster's service endpoint. After you enable this feature, you can use the `PATCH /network/v2/satellite-acl/{idOrName}/add` API to add subnets to the allowlist for this Satellite cluster's service endpoint. Only authorized requests to your Satellite cluster master that originate from subnets in the allowlist are permitted through the Satellite cluster's service endpoints.", "tags": [ "acl" ], "summary": "Enable the subnet allowlist for a Satellite cluster's service endpoint.", "operationId": "EnableSatelliteClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite cruiser. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted. The request to enable the allowlist feature for your Satellite cluster's service endpoint was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The Satellite service endpoint allowlist feature is already enabled on the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified Satellite cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/network/v2/satellite-acl/{idOrName}/enable\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/network/v2/satellite-acl/{idOrName}/rm": { "patch": { "description": "Remove subnets that you previously added to the allowlist for a Satellite cluster's service endpoint. After a subnet is removed, any requests that originate from this subnet to the Satellite cluster master through the service endpoint are denied.", "tags": [ "acl" ], "summary": "Remove subnets from a Satellite cluster's service endpoint allowlist.", "operationId": "RemoveSatelliteClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/csePatchACL" } } }, "description": "The list of subnets to remove from the Satellite cluster's service endpoint allowlist.", "required": true }, "x-codegen-request-body-name": "csePatchACL", "responses": { "202": { "description": "Accepted. The subnets are successfully removed from the Satellite cluster's service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "204": { "description": "No content. The subnets are successfully removed from the Satellite cluster's service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Satellite Service Endpoint Allowlist feature is disabled on the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified Satellite cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/network/v2/satellite-acl/{idOrName}/rm\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"aclList\": [\n", " \"example-value\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/network/v2/secure-by-default/enable": { "post": { "tags": [ "secure-by-default" ], "summary": "Enable VPC Secure by Default Networking on an existing VPC cluster.", "operationId": "EnableSecureByDefaultClusterRequest", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableSecureByDefaultClusterRequest" } } }, "description": "Enable a one-way migration to Secure by Default Networking on an existing VPC cluster currently using legacy security groups. Available options for `disableOutboundTrafficProtection` are `true` or `false`.", "required": true }, "x-codegen-request-body-name": "enableSecureByDefaultOperation", "responses": { "202": { "description": "Accepted. The request to enable Secure by Default Networking was successful.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The query parameters are either incomplete or in the wrong format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/network/v2/secure-by-default/enable\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"disableOutboundTrafficProtection\": false\n", "}'\n" ] } ] } ] } } } }, "/network/v2/security-group": { "post": { "tags": [ "security-group" ], "summary": "Perform operations against a VPC Security Group associated with a cluster.", "operationId": "securityGroupsOperation", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityGroupRequest" } } }, "description": "Perform an operation against a VPC security group associated with a cluster. Currently supported operations are `reset` or `sync`.", "required": true }, "x-codegen-request-body-name": "securityGroupOperation", "responses": { "202": { "description": "Accepted. The requested security group operation was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The query parameters are either incomplete or in the wrong format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/network/v2/security-group\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"operation\": \"example-value\",\n", " \"securityGroupID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/network/v2/security-group/getSecurityGroups": { "get": { "tags": [ "security-group" ], "summary": "List all security groups associated with a cluster.", "operationId": "getSecurityGroups", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Filter security groups by type. Specify `cluster`, `worker`, `vpc`, `vpegw`, or `lbaas`.", "name": "type", "in": "query", "schema": { "type": "string" } }, { "description": "Specify `true` to return the security groups that are shared across the VPC. Or, specify `false` to return only the cluster specific security groups.", "name": "shared", "in": "query", "schema": { "type": "string" } }, { "description": "Specify `true` to return the security groups created by user. Specify `false` to return only the IKS managed security groups.", "name": "user_provided", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of security groups associated with the cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetSecurityGroupsResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "id": "example-id-123", "name": "my-cluster", "shared": false, "type": "example-value", "userProvided": false, "workerPoolID": "example-id-123" } ] } } }, "400": { "description": "Bad request. The query parameters are either incomplete or in the wrong format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/network/v2/security-group/getSecurityGroups?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/regional/v2/cluster-health/getIssue": { "get": { "description": "Same behavior as `GET /v2/cluster-health/getIssue`.", "tags": [ "cluster-health" ], "summary": "Get detailed information for one health issue (regional URL prefix).", "operationId": "getClusterHealthIssueRegional", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "Cluster ID or name.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Issue code.", "name": "issue", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Detailed health issue payload.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetailedHealthIssue" }, "example": { "component": "example-value", "description": "example-value", "detected": "example-value", "id": "example-id-123", "more_details": [ { "affected_component_type": "example-value", "affected_components": [ "example-value" ], "message": "example-value", "type": 1 } ], "severity": "example-value", "solution": "example-value" } } } }, "400": { "description": "Bad request.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "410": { "description": "Gone.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/regional/v2/cluster-health/getIssue?cluster=example-value&issue=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/regional/v2/cluster-health/getIssues": { "get": { "description": "Same behavior as `GET /v2/cluster-health/getIssues`. Use this path when calling a regional Kubernetes Service endpoint directly.", "tags": [ "cluster-health" ], "summary": "List aggregated health issues for a cluster (regional URL prefix).", "operationId": "listClusterHealthIssuesRegional", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "Cluster ID or name.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. An array of health issue summaries.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HealthIssueListItem" }, "minItems": 0, "maxItems": 100 }, "example": [ { "component": "example-value", "description": "example-value", "detected": "example-value", "id": "example-id-123", "severity": "example-value" } ] } } }, "400": { "description": "Bad request.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Gone.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/regional/v2/cluster-health/getIssues?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/acl/{idOrName}": { "get": { "description": "Get a cluster's private service endpoint allowlist.\n\nList all subnets in the allowlist for a cluster's private service endpoint. This list includes subnets that you manually added by using the `PATCH /v1/acl/{idOrName}/add` API and subnets that are automatically added and managed by IBM, such as worker node subnets.", "tags": [ "acl" ], "summary": "Deprecated: Private service endpoint allowlists are no longer supported and c...", "operationId": "GetClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The allowlist for the cluster's private service endpoint is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ACLResponse" }, "example": { "actualCSEACLList": { "customAclEntries": [ "example-value" ], "systemAclEntries": [ "example-value" ] }, "desiredCSEACLList": { "customAclEntries": [ "example-value" ], "systemAclEntries": [ "example-value" ] } } } } }, "400": { "description": "Bad request. Private Service Endpoint Allowlist feature is disabled on the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/acl/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "delete": { "description": "Disable the subnet allowlist for a cluster's private service endpoint.\n\nDisable the subnet allowlist feature for a cluster's private service endpoint. After you disable this feature, authorized requests to your cluster master through the cluster's private service endpoint can originate from any subnet.", "tags": [ "acl" ], "summary": "Deprecated: Private service endpoint allowlists are no longer supported and c...", "operationId": "DisableClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted. The request to disable the allowlist feature for your cluster's private service endpoint was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/acl/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/acl/{idOrName}/add": { "patch": { "description": "Add subnets to a cluster's private service endpoint allowlist.\n\nAfter you use the `POST /v1/acl/{idOrName}/enable` API to enable an allowlist for your cluster's private service endpoint, add subnets to the allowlist. Only authorized requests to your cluster master that originate from subnets in this allowlist are permitted through the cluster's private service endpoint. By default, subnets for your cluster's worker nodes are added to this allowlist so that worker nodes can communicate with the master through the private service endpoint.", "tags": [ "acl" ], "summary": "Deprecated: Private service endpoint allowlists are no longer supported and c...", "operationId": "AddClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/csePatchACL" } } }, "description": "The list of subnets to add to the cluster's private service endpoint allowlist.", "required": true }, "x-codegen-request-body-name": "csePatchACL", "responses": { "201": { "description": "Created. The subnets are successfully added to the cluster's private service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "204": { "description": "No content. The subnets are successfully added to the cluster's private service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Private Service Endpoint Allowlist feature is disabled on the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v1/acl/{idOrName}/add\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"aclList\": [\n", " \"example-value\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/v1/acl/{idOrName}/enable": { "post": { "description": "Enable a subnet allowlist for a cluster's private service endpoint.\n\nEnable the subnet allowlist feature for a cluster's private service endpoint. After you enable this feature, you can use the `PATCH /v1/acl/{idOrName}/add` API to add subnets to the allowlist for this cluster's private service endpoint. Only authorized requests to your cluster master that originate from subnets in the allowlist are permitted through the cluster's private service endpoint. If the public service endpoint is enabled for your cluster, authorized requests are still permitted through the public service endpoint.", "tags": [ "acl" ], "summary": "Deprecated: Private service endpoint allowlists are no longer supported and c...", "operationId": "EnableClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted. The request to enable the allowlist feature for your cluster's private service endpoint was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The private service endpoint allowlist feature is already enabled on the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/acl/{idOrName}/enable\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/acl/{idOrName}/rm": { "patch": { "description": "Remove subnets from a cluster's private service endpoint allowlist.\n\nRemove subnets that you previously added to the allowlist for a cluster's private service endpoint. After a subnet is removed, any requests that originate from this subnet to the cluster master through the private service endpoint are denied.", "tags": [ "acl" ], "summary": "Deprecated: Private service endpoint allowlists are no longer supported and c...", "operationId": "RemoveClusterACLs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/csePatchACL" } } }, "description": "The list of subnets to remove from the cluster's private service endpoint allowlist.", "required": true }, "x-codegen-request-body-name": "csePatchACL", "responses": { "202": { "description": "Accepted. The subnets are successfully removed from the cluster's private service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "204": { "description": "No content. The subnets are successfully removed from the cluster's private service endpoint allowlist.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. Private Service Endpoint Allowlist feature is disabled on the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v1/acl/{idOrName}/rm\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"aclList\": [\n", " \"example-value\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/v1/addons": { "get": { "description": "List available add-ons that you can enable in a cluster. For each available add-on, the name, latest version, and minimum Kubernetes version required to run the add-on in a cluster are returned.", "tags": [ "util" ], "summary": "List available add-ons that you can enable in a cluster.", "operationId": "GetAddons", "responses": { "200": { "description": "OK. The name, latest version, and minimum required Kubernetes version for each available add-on are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/AddonCommon" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/addons\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/alb/albs": { "post": { "description": "Enable a public or private ALB in your standard cluster.", "tags": [ "ingress-alb" ], "summary": "Enable an existing ALB in a cluster.", "operationId": "EnableALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALBConfig" } } }, "description": "The input parameter to enable an ALB. In the `albip` field, you can optionally specify an IP address that is on a VLAN in the zone that the ALB was created in. The ALB is enabled with and uses this public or private IP address. Note that this IP address must not be in use by another load balancer or ALB in the cluster. If no IP address is provided, the ALB is deployed with a public or private IP address from the portable public or private subnet that was provisioned automatically when you created the cluster, or the public or private IP address that you previously assigned to the ALB. To switch your ALB from one type of image to another, such as from an IBM Cloud Kubernetes Service ALB image to a community Kubernetes Ingress controller image, specify that image version in the ALBBuild field. To see the supported image versions, use the `GET /v2/alb/getAlbImages` call. For more information, see https://ibm.biz/alb_configure_docs", "required": true }, "x-codegen-request-body-name": "albConfig", "responses": { "201": { "description": "Enabled. The ALB for the cluster was successfully enabled.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster or ALB could not be found. To list the clusters that you have access to, run `ibmcloud ks cluster ls`. To list the ALBs available in a cluster, use the `GET /clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/alb/albs\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"albBuild\": \"example-value\",\n", " \"albID\": \"example-id-123\",\n", " \"albType\": \"example-value\",\n", " \"authBuild\": \"example-value\",\n", " \"cluster\": \"example-value\",\n", " \"createdDate\": \"example-value\",\n", " \"disableDeployment\": false,\n", " \"enable\": true\n", "}'\n" ] } ] } ] } } } }, "/v1/alb/albs/{albID}": { "get": { "description": "View detailed information for an ALB in a cluster.", "tags": [ "ingress-alb" ], "summary": "View details of an ALB.", "operationId": "GetClusterALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the ALB that you want details for. To list the IDs for the ALBs in a cluster, use the `GET /clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "name": "alb_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Details for the specified ALB are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALBConfig" }, "example": { "albBuild": "example-value", "albID": "example-id-123", "albType": "example-value", "authBuild": "example-value", "cluster": "example-value", "createdDate": "example-value", "disableDeployment": false, "enable": true } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or ALB could not be found. To list the clusters that you have access to, run `ibmcloud ks cluster ls`. To list the ALBs available in a cluster, use the `GET /clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/alb/albs/{albID}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "delete": { "description": "Disable a public or private ALB in your standard cluster. When you disable an ALB, the IP address that the ALB used goes back into the pool of available portable IPs so that another service can use the IP. If you later try to re-enable the ALB, the ALB might report an error if the IP address it previously used is now in use by another service. You can either stop running the other service or specify another IP address to use when you re-enable the ALB.", "tags": [ "ingress-alb" ], "summary": "Disable an ALB in your cluster.", "operationId": "DisableALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the ALB that you want to disable. To list the IDs for the ALBs in a cluster, use the `GET /v1/alb/clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "name": "alb_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Disabled. The ALB for the cluster was successfully disabled.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or ALB could not be found. To list the clusters that you have access to, run `ibmcloud ks cluster ls`. To list the ALBs available in a cluster, use the `GET /clusters/{idOrName}` API or run `ibmcloud ks alb ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/alb/albs/{albID}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/alb/clusters/{idOrName}": { "get": { "description": "List all ALB IDs in a cluster. If no ALB IDs are returned, then the cluster does not have a portable subnet.", "tags": [ "ingress-alb" ], "summary": "List all ALBs in a cluster.", "operationId": "GetClusterALBs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to see ALB information for. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of ALB IDs for the cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ClusterALB" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/alb/clusters/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/alb/clusters/{idOrName}/update": { "put": { "description": "If automatic updates for Ingress ALBs are disabled, you can force a one-time update of your ALB pods. When you choose to manually update the ALBs, all ALB pods in the cluster are updated to the latest build. You cannot update an individual ALB or choose which build to update the ALBs to. Automatic updates remain disabled.", "tags": [ "ingress-alb" ], "summary": "Force a one-time update of all ALB pods to the latest build.", "operationId": "UpdateALBs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The update has been requested.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/alb/clusters/{idOrName}/update\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/alb/clusters/{idOrName}/updatepolicy": { "get": { "description": "Check if automatic updates for Ingress ALBs are enabled and whether your ALB pods are updated to the latest build version.", "tags": [ "ingress-alb" ], "summary": "Check if automatic updates for Ingress ALBs are enabled in a cluster.", "operationId": "GetUpdatePolicy", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The current update policy.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePolicy" }, "example": { "autoUpdate": false, "latestVersion": false } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/alb/clusters/{idOrName}/updatepolicy\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "put": { "description": "By default, automatic updates to Ingress ALBs are enabled. ALB pods are automatically updated when a new build version is available. To instead update the Ingress ALB component manually, you can use this call to disable automatic updates, then use the `PUT /clusters/{idOrName}/update` call to update all ALB pods.\nNote: When you update the major or minor Kubernetes version of your cluster, IBM automatically makes necessary changes to the Ingress deployment, but does not change the build version of your Ingress ALBs. You are responsible for checking the compatability of the latest Kubernetes versions and your Ingress ALB add-on images. If automatic updates for the Ingress ALB component are disabled, you can re-enable automatic updates. Whenever the next build version becomes available, the ALBs are automatically updated to the latest build.", "tags": [ "ingress-alb" ], "summary": "Enable or disable automatic updates for the Ingress ALBs in a cluster.", "operationId": "ChangeUpdatePolicy", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePolicy" } } }, "description": "The new update policy configuration.", "required": true }, "x-codegen-request-body-name": "updatePolicy", "responses": { "204": { "description": "Ok. The ALB update policy has been changed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/alb/clusters/{idOrName}/updatepolicy\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"autoUpdate\": false,\n", " \"latestVersion\": false\n", "}'\n" ] } ] } ] } } } }, "/v1/alb/clusters/{idOrName}/zone/{zoneId}": { "post": { "description": "Create a new public or private ALB in a specified zone on a specified VLAN. You can also optionally specify an IP address on that VLAN in that zone for the ALB to use.", "tags": [ "ingress-alb" ], "summary": "Create a public or private ALB in a specified zone and VLAN.", "operationId": "CreateALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to see ALB information for. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The zone in which you want to create an ALB. To see the zones where you can create an ALB, run `ibmcloud ks cluster-get --cluster ` and look for the `Worker Zones` field in the output.", "name": "zone_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALB" } } }, "description": "The input parameters to create an ALB. For more information, see https://ibm.biz/alb_create_docs", "required": true }, "x-codegen-request-body-name": "alb", "responses": { "201": { "description": "The ALB was successfully created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlbCreateResp" }, "example": { "alb": "example-value", "cluster": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster or zone could not be found. To list the clusters that you have access to, run `ibmcloud ks cluster ls`. To list the zones available in a cluster, use the `GET /v1/clusters/{idOrName}` API or run `ibmcloud ks cluster-get --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/alb/clusters/{idOrName}/zone/{zoneId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"enableByDefault\": true,\n", " \"ingressImage\": \"example-value\",\n", " \"type\": \"example-value\",\n", " \"zone\": \"us-south-1\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters": { "get": { "description": "List the clusters that you have access to.", "tags": [ "clusters" ], "summary": "List the clusters that you have access to.", "operationId": "GetClusters", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to list clusters for. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, all the clusters in the account that you have access to are listed.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "Specify a location to filter clusters for. To see supported locations, use the `GET /v1​/locations` API or run `ibmcloud ks locations`.", "name": "location", "in": "query", "schema": { "type": "string" } }, { "description": "To view additional cluster resources like addons, VLANs, subnets, and storage, pass `true`.", "name": "show_resources", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of clusters that you have access to is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/Cluster" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Clusters are listed.", "events": [ { "name": "containers-kubernetes.cluster.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Create a cluster in the IBM Cloud account that you are logged into.\nNote: This API method requires Administrator platform role for IBM Cloud Kubernetes Service at the account level, as well as access to several other services such as the underlying infrastructure provider. For more information, see 'https://ibm.biz/cluster-perms'.", "tags": [ "clusters" ], "summary": "Create a cluster.", "operationId": "CreateCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to create the cluster in. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, the cluster is created in the default resource group. After you create a cluster, you cannot change the resource group. Note that if you plan to integrate IBM Cloud services with the cluster, all the resources must be in the same group.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterConfig" } } }, "description": "Input parameter to add a cluster. For more information, see https://ibm.biz/cluster_create_docs", "required": true }, "x-codegen-request-body-name": "clusterConfig", "responses": { "201": { "description": "Created. The cluster was successfully created in the IBM Cloud account that you are logged in to.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterCreateResponse" }, "example": { "id": "example-id-123", "non_critical_errors": { "incidentID": "example-id-123", "items": [ { "code": "example-value", "description": "example-value", "recoveryCLI": "example-value", "terseDescription": "example-value", "type": "example-value" } ] } } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "409": { "description": "Conflict. A cluster with the same name already exists. Choose another name for your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The creation of a cluster is requested. This event is sent for any type of cluster, such as clusters that are created in different infrastructure providers.", "events": [ { "name": "containers-kubernetes.cluster.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cseAclEnabled\": true,\n", " \"dataCenter\": \"example-value\",\n", " \"defaultWorkerPoolEntitlement\": \"example-value\",\n", " \"defaultWorkerPoolName\": \"my-cluster\",\n", " \"disableAutoUpdate\": false,\n", " \"diskEncryption\": false,\n", " \"gatewayEnabled\": true,\n", " \"isolation\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}": { "get": { "description": "View detailed information for a cluster.", "tags": [ "clusters" ], "summary": "View details for a cluster.", "operationId": "GetClusterV1", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want information about. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "To view additional cluster resources like addons, VLANs, subnets, and storage, pass `true`.", "name": "show_resources", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cluster" }, "example": { "addons": [ { "enabled": true, "name": "my-cluster", "state": "example-value", "status": "example-value" } ], "apiUser": "example-value", "createdDate": "example-value", "crn": "example-value", "dataCenter": "example-value", "desiredTrustedProfileID": "example-id-123", "disableAutoUpdate": false, "etcdPort": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Details for a cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "put": { "description": "Update the Kubernetes master to the default API version. During the update, you cannot access or change the cluster. Worker nodes, apps, and resources that have been deployed by the user are not modified and will continue to run. You might need to change your YAML files for future deployments. For details, see the release notes at https://cloud.ibm.com/docs/containers?topic=containers-cs_versions", "tags": [ "clusters" ], "summary": "Update the version of the Kubernetes cluster master node.", "operationId": "UpdateCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMasterCommand" } } }, "description": "Input parameter to update the Kubernetes master. Set `action` to `update` to update the master. Set `force` to `true` to attempt the update even if the change is greater than two minor versions. Set `version` to the Kubernetes version of the cluster. If you do not specify a version, the Kubernetes master is updated to the default API version. To see available versions, use the `GET /v1/kube-versions` API or run `ibmcloud ks versions`.", "required": true }, "x-codegen-request-body-name": "apiCommand", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The cluster cannot be updated. The master is more than two versions behind the targeted version, which is not supported. Instead, update to a supported version two or less ahead of the current version, or create a new cluster at the targeted version.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The specified value is already set on the cluster. To list the clusters properties, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster master update is requested.", "events": [ { "name": "containers-kubernetes.cluster-master.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/clusters/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"action\": \"example-value\",\n", " \"force\": false,\n", " \"version\": \"1.28.5\"\n", "}'\n" ] } ] } ] } } }, "delete": { "description": "Delete a cluster from the IBM Cloud account that you are logged in to. When you delete a cluster, all worker nodes, apps, and containers are permanently deleted. This action cannot be undone.", "tags": [ "clusters" ], "summary": "Delete a cluster.", "operationId": "RemoveCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to remove. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "To delete additional resources linked to the cluster such as VLANs, subnets, and storage, pass `true`.", "name": "delete_resources", "in": "query", "schema": { "type": "string" } }, { "description": "To skip checking for infrastructure permissions before completing this action, pass 'true'. Note that if you do not have the correct infrastructure permissions, this action might only partially succeed.", "name": "skip_permissions_precheck", "in": "query", "schema": { "type": "string" } }, { "description": "To delete the COS bucket and the associated service key that holds OpenShift registry backups, pass `true`", "name": "delete_open_shift_registry_cos_bucket", "in": "query", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The cluster was successfully removed from the IBM Cloud account that you are logged in to.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster is deleted.", "events": [ { "name": "containers-kubernetes.cluster.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/clusters/{idOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/addons": { "get": { "description": "View details of the add-ons that are enabled in a cluster, including the add-on versions.", "tags": [ "clusters" ], "summary": "View details of the add-ons that are enabled in a cluster.", "operationId": "GetClusterAddons", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group of the cluster, use the `GET /v1/clusters/{idOrName}` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Details for the add-ons in this cluster are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ClusterAddon" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Cluster add-ons are listed.", "events": [ { "name": "containers-kubernetes.cluster-addon.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/addons\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "patch": { "description": "Enable, disable, or update add-ons for a cluster.", "tags": [ "clusters" ], "summary": "Enable, disable, or update add-ons for a cluster.", "operationId": "ManageClusterAddons", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group of the cluster, use the `GET /v1/clusters/{idOrName}` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddonRequest" } } }, "description": "Input parameters to enable or disable add-ons in your cluster.", "required": true }, "x-codegen-request-body-name": "addonRequest", "responses": { "200": { "description": "OK. The add-on changes have been processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddonResponse" }, "example": { "missingDeps": [ { "allowed_upgrade_versions": [ "1.28.5" ], "defaultVersions": [ { "infrastructureProvider": [ "vpc-gen2" ], "kubeRange": "1.28.5", "ocpRange": "example-value", "version": "1.28.5" } ], "deprecated": false, "healthState": "example-value", "healthStatus": "example-value", "installOptionsTemplate": { "content": "example-value", "immutable": false }, "minKubeVersion": "1.28.5", "minOCPVersion": "1.28.5", "name": "my-cluster" } ], "orphanedAddons": {} } } } }, "400": { "description": "Bad request. The input parameters in the request body are not correct. Be sure to include all of the required parameters in your request in the correct JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The current add-on configuration is not compatible. Check 'MissingDeps' for add-ons to enable in this cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddonResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The event that is generated depends on the operation that you request for the cluster add-on.", "events": [ { "description": "A cluster add-on is enabled. Generated if `enable` is passed for the `addonRequest` parameter.", "name": "containers-kubernetes.cluster-addon.enable" }, { "description": "A cluster add-on is disabled. Generated if `disable` is passed for the `addonRequest` parameter.", "name": "containers-kubernetes.cluster-addon.disable" }, { "description": "A cluster add-on is updated. Generated if `update` is passed for the `addonRequest` parameter.", "name": "containers-kubernetes.cluster-addon.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v1/clusters/{idOrName}/addons\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"addons\": [\n", " {\n", " \"allowed_upgrade_versions\": [\n", " \"1.28.5\"\n", " ],\n", " \"defaultVersions\": [\n", " {\n", " \"infrastructureProvider\": [\n", " \"vpc-gen2\"\n", " ],\n", " \"kubeRange\": \"1.28.5\",\n", " \"ocpRange\": \"example-value\",\n", " \"version\": \"1.28.5\"\n", " }\n", " ],\n", " \"deprecated\": false,\n", " \"healthState\": \"example-value\",\n", " \"healthStatus\": \"example-value\",\n", " \"installOptionsTemplate\": {\n", " \"content\": \"example-value\",\n", " \"immutable\": false\n", " },\n", " \"minKubeVersion\": \"1.28.5\",\n", " \"minOCPVersion\": \"1.28.5\",\n", " \"name\": \"my-cluster\"\n", " }\n", " ],\n", " \"enable\": true,\n", " \"update\": false\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/apiserverconfigs/auditwebhook": { "get": { "description": "View the URL for the remote logging service that you are sending API server audit logs to.", "tags": [ "apiserverconfigs" ], "summary": "View details for an audit webhook configuration.", "operationId": "GetAuditWebhook", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want audit configuration details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved the audit webhook configuration.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditWebhookConfig" }, "example": { "auditServer": "example-value", "caCertificate": "example-value", "clientCertificate": "example-value", "clientKey": "example-value", "policy": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Audit webhooks for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-audit-webhook.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/apiserverconfigs/auditwebhook\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "put": { "description": "Create or update an audit webhook configuration for a cluster. The webhook sends Kubernetes API server audit logs that allow you to monitor API requests to your cluster.", "tags": [ "apiserverconfigs" ], "summary": "Create or update an audit webhook configuration for a cluster.", "operationId": "UpdateAuditWebhook", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster where you want to add an audit configuration or change the audit configuration. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditWebhookConfig" } } }, "description": "The input parameter for creating or updating an audit webhook configuration. For more information, see https://ibm.biz/audit_config_docs", "required": true }, "x-codegen-request-body-name": "auditConfig", "responses": { "204": { "description": "Ok. The cluster will send audit logs to the audit server.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "412": { "description": "Precondition failed. The input parameters in the request body are incorrect. Some typical cases include if the audit server is http and certs are provided or if the server is https and not all certs are provided.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster audit webhook for forwarding master API server audit logs is updated.", "events": [ { "name": "containers-kubernetes.cluster-audit-webhook.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To get the action, the user must have the Editor platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/clusters/{idOrName}/apiserverconfigs/auditwebhook\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"auditServer\": \"example-value\",\n", " \"caCertificate\": \"example-value\",\n", " \"clientCertificate\": \"example-value\",\n", " \"clientKey\": \"example-value\",\n", " \"policy\": \"example-value\"\n", "}'\n" ] } ] } ] } } }, "delete": { "description": "Disable the webhook backend configuration for the cluster's API server. Diabling the webhook backend stops forwarding API server audit logs to a remote server.", "tags": [ "apiserverconfigs" ], "summary": "Delete an audit webhook configuration.", "operationId": "DeleteAuditWebhook", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster for which you want to change the audit config. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully deleted the audit webhook configuration.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster audit webhook for forwarding master API server audit logs is removed.", "events": [ { "name": "containers-kubernetes.cluster-audit-webhook.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/clusters/{idOrName}/apiserverconfigs/auditwebhook\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/config": { "get": { "description": "Get the cluster-specific Kubernetes configuration data and certificates as a tar file to connect to your cluster and run Kubernetes API calls. To retrieve the administrator certificates and keys, pass `admin` at the end of the path. For example, `/v1/clusters/{idOrName}/config/admin`.", "tags": [ "clusters" ], "summary": "Get the cluster-specific configuration and certificates.", "operationId": "GetClusterConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) refresh token. To retrieve your IAM refresh token, run `cat ~/.bluemix/config.json`. To use the `POST https://iam.cloud.ibm.com/identity/token` API to create a token, see https://ibm.biz/iks-tokens for the required request headers.", "name": "X-Auth-Refresh-Token", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster for which you want to download the Kubernetes configuration file and certificates. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The format of the user identity to use in the Kubernetes configuration and policies. Must match the IAM provided user email, up to letter case.", "name": "sub", "in": "query", "schema": { "type": "string" } }, { "description": "To format the output in a single YAML file, pass `yaml`.", "name": "format", "in": "query", "schema": { "type": "string" } }, { "description": "Retrieve the Calico network config with the Admin config. This only works against the admin endpoint('/config/admin')", "name": "create_network_config", "in": "query", "schema": { "type": "boolean" } }, { "description": "Deprecated: Previously this skipped adding the RBAC roles based on user's access in IAM. RBAC is now always applied and completes asynchronously.", "name": "skip_rbac", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok. The cluster-specific configuration file and certificates are returned as a zip file.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The Kubernetes configuration file (`kubeconfig`) for a cluster is requested. Depending on the request, the `kubeconfig` might contain administrator or network certificates and secrets to access the cluster.", "events": [ { "name": "containers-kubernetes.cluster.config" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/config\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/kms": { "post": { "description": "Create a configuration to enable a key management service (KMS) provider, such as IBM Key Protect, in your cluster. Your customer root key (CRK) from the KMS provider is used to encrypt the Kubernetes secrets within your cluster.\nAfter you enable KMS for your cluster, you can update the instance, endpoint, or CRK parameters that are used, but you cannot remove the KMS provider from your cluster.\nNote on permissions: This API method requires the IBM Cloud IAM Administrator platform role for IBM Cloud Kubernetes Service at the account level. The API key that is used for the region and resource group that the cluster is in requires the appropriate permission to create an instance and CRK in the KMS provider, such as the Editor platform and Writer service role for Key Protect. An additional Reader service-to-service authorization policy between IBM Cloud Kubernetes Service and Key Protect is automatically created for your cluster, if the policy does not already exist. Without this policy, your cluster cannot use all the Key Protect features.", "tags": [ "clusters" ], "summary": "Create and enable a key management service (KMS) provider configuration for a...", "operationId": "CreateKMSConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group of the cluster, use the `GET /v1/clusters/{idOrName}` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyProtectData" } } }, "description": "Input parameters to create the Key Protect config for your cluster. The user specified URL parameter is ignored, because it is fetched from Ghost.", "required": true }, "x-codegen-request-body-name": "keyProtectConfig", "responses": { "201": { "description": "OK. Your Key Protect config will be applied to the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are not correct. Be sure to include all of the required parameters in your request in the correct JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. Processing multiple concurrent requests from your account to create a Key Protect config for the cluster. Wait a few minutes and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The IBM Cloud services that are bound to a cluster are listed, across all Kubernetes namespaces in the cluster.", "events": [ { "name": "containers-kubernetes.cluster-service.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/kms\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"accountID\": \"example-id-123\",\n", " \"correlationID\": \"example-id-123\",\n", " \"crkID\": \"example-id-123\",\n", " \"instanceID\": \"example-id-123\",\n", " \"serviceToService\": false,\n", " \"url\": \"https://example.com\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/masters": { "put": { "description": "Restart the Kubernetes master in the cluster to apply changes to the API server configuration.", "tags": [ "clusters" ], "summary": "Refresh the Kubernetes master.", "operationId": "HandleMasterAPIServer", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to interact with. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterAPIServer" } } }, "description": "The master state. Currently, `refresh` is supported." }, "x-codegen-request-body-name": "state", "responses": { "204": { "description": "Ok. The Master will be put into the desired state.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad Request. Check that all headers are present and that the state is valid. Valid states include `refresh`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster master refresh is requested.", "events": [ { "name": "containers-kubernetes.cluster-master.refresh" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/clusters/{idOrName}/masters\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"action\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/services": { "get": { "description": "List the IBM Cloud services that are bound in any Kubernetes namespace in the cluster.", "tags": [ "clusters" ], "summary": "List the IBM Cloud services bound to a cluster across all namespaces.", "operationId": "ListServicesForAllNamespaces", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster where you want to list bound IBM Cloud services. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of IBM Cloud services bound to a cluster across all Kubernetes namespaces is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoundService" }, "minItems": 0, "maxItems": 100 }, "example": [ { "namespace": "my-cluster", "serviceid": "example-id-123", "servicekeyname": "my-cluster", "servicename": "my-cluster" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "404": { "description": "Not found. The specified cluster ID or name could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } } }, "x-ibm-events": { "description": "The IBM Cloud services that are bound to a cluster are listed, across all Kubernetes namespaces in the cluster.", "events": [ { "name": "containers-kubernetes.cluster-service.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/services\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Bind an IBM Cloud service instance to a Kubernetes namespace in your cluster. To view available IBM Cloud services from the IBM Cloud catalog, run `ibmcloud catalog search --kind service`. If you already provisioned IBM Cloud service instances in an IBM Cloud space, you can list them by running `ibmcloud resource service-instances`.\nNote: You can add only IBM Cloud services that support service keys, and you must add the service in the same resource group that the cluster is in.", "tags": [ "clusters" ], "summary": "Bind an IBM Cloud service to a cluster.", "operationId": "BindServiceToNamespace", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster where you want to bind your service. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBindRequest" } } }, "description": "The ID of the IBM Cloud service instance that you want to bind. To find the ID of the service instance, use the `GET /v1/clusters/{idOrName}/services` API or run `{[bxcs]} cluster-services `.", "required": true }, "x-codegen-request-body-name": "serviceBindRequest", "responses": { "201": { "description": "Created. Your IBM Cloud service instance was successfully bound to the Kubernetes namespace of your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBindResponse" }, "example": { "binding": "example-value", "namespaceID": "my-cluster", "secretName": "my-cluster", "serviceInstanceGUID": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } } }, "x-ibm-events": { "description": "An IBM Cloud service is bound to a namespace in the cluster.", "events": [ { "name": "containers-kubernetes.cluster-service.bind" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To get the action, the user must have the Editor platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/services\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"namespaceID\": \"my-cluster\",\n", " \"role\": \"example-value\",\n", " \"serviceInstanceGUID\": \"example-id-123\",\n", " \"serviceKeyGUID\": \"example-id-123\",\n", " \"serviceKeyJSON\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/services/{namespace}": { "get": { "description": "List the IBM Cloud services that are bound to a specific Kubernetes namespace in a cluster.", "tags": [ "clusters" ], "summary": "List the IBM Cloud services bound to a specific namespace in a cluster.", "operationId": "ListServicesInNamespace", "parameters": [ { "description": "Your IAM IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster where you want to list bound IBM Cloud services. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The Kubernetes namespace in your cluster where you want to list all bound IBM Cloud services.", "name": "namespace", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of services bound to a cluster within a specific Kubernetes namespace is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoundService" }, "minItems": 0, "maxItems": 100 }, "example": [ { "namespace": "my-cluster", "serviceid": "example-id-123", "servicekeyname": "my-cluster", "servicename": "my-cluster" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "404": { "description": "Not found. The specified Kubernetes namespace or cluster ID/name could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To view available Kubernetes namespaces, run `kubectl get namespaces`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } } }, "x-ibm-events": { "description": "The IBM Cloud services that are bound to a cluster are listed, filtered to a Kubernetes namespace in the cluster.", "events": [ { "name": "containers-kubernetes.cluster-service.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/services/my-cluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/services/{namespace}/{serviceInstanceId}": { "delete": { "description": "Unbind an IBM Cloud service instance from a Kubernetes namespace in your cluster.\nNote: When you remove an IBM Cloud service, the service credentials are removed from the cluster. If a pod is still using the service, it fails because the service credentials cannot be found.", "tags": [ "clusters" ], "summary": "Unbind an IBM Cloud service from a cluster.", "operationId": "UnbindServiceFromNamespace", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster where you want to unbind your IBM Cloud service instance. To list bound IBM Cloud services and their namespaces, use the `GET /v1/clusters/{nameOrId}/services` API or run `ibmcloud ks cluster service ls --cluster `.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The Kubernetes namespace where your IBM Cloud service was bound to. To list bound IBM Cloud services and their namespaces, use the `GET /v1/clusters/{nameOrId}/services` API or run `ibmcloud ks cluster service ls --cluster `.", "name": "namespace", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the IBM Cloud service instance that was bound to your cluster. To list bound IBM Cloud services and their namespaces, use the `GET /v1/clusters/{nameOrId}/services` API or run `ibmcloud ks cluster service ls --cluster `.", "name": "service_instance_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The IBM Cloud service instance was successfully unbound from the Kubernetes namespace of your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "404": { "description": "Not found. The specified cluster, IBM Cloud service instance, or namespace could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list bound IBM Cloud services and their namespaces, use the `GET /v1/clusters/{nameOrId}/services` API or run `ibmcloud ks cluster service ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } } }, "x-ibm-events": { "description": "An IBM Cloud service is removed from a namespace in the cluster.", "events": [ { "name": "containers-kubernetes.cluster-service.unbind" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To get the action, the user must have the Editor platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/clusters/{idOrName}/services/my-cluster/{serviceInstanceId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/subnets": { "get": { "description": "List subnets from your IBM Cloud classic infrastructure account that are bound to a cluster. Before you can call this API method, a one-time per account `POST /v1/credentials` is required.", "tags": [ "clusters" ], "summary": "List classic subnets that are bound to a cluster.", "operationId": "GetClusterSubnets", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of user-managed subnets that are bound to your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VlanConfigField" }, "minItems": 0, "maxItems": 100 }, "example": [ { "id": "example-id-123", "region": "us-south", "subnets": [ { "cidr": "example-id-123", "id": "example-id-123", "ips": [ "example-value" ], "is_byoip": false, "is_public": false } ], "zone": "us-south-1" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The subnets for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-subnet.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/subnets\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/subnets/{subnetId}": { "put": { "description": "Make an existing IBM Cloud classic infrastructure subnet available to an existing cluster.\nNote: When you make a subnet available to a cluster, IP addresses of this subnet are used for cluster networking purposes. To avoid IP address conflicts, make sure that you use a subnet with one cluster only. Do not use a subnet for multiple clusters or for other purposes outside of Kubernetes Service at the same time.", "tags": [ "clusters" ], "summary": "Add an IBM Cloud classic infrastructure subnet to a cluster.", "operationId": "AddClusterSubnet", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to make an existing subnet available to. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the subnet in your IBM Cloud infrastructure account that you want to add to your cluster. To list available subnets, run `ibmcloud ks subnets`.", "name": "subnet_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The specified subnet was successfully made available to your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An existing IBM Cloud infrastructure subnet is added to a cluster.", "events": [ { "name": "containers-kubernetes.subnet.add" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/clusters/{idOrName}/subnets/{subnetId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "patch": { "description": "Detach a subnet in your IBM Cloud classic infrastructure account from a cluster. The subnet remains available in your infrastructure account after it is detached.", "tags": [ "clusters" ], "summary": "Detach a public or private portable subnet from a cluster.", "operationId": "DetachClusterSubnet", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to remove the subnet from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the subnet that you want to remove from your cluster.", "name": "subnet_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The specified subnet was successfully removed from your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A public or private portable subnet is detached from a cluster.", "events": [ { "name": "containers-kubernetes.cluster-subnet.detach" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v1/clusters/{idOrName}/subnets/{subnetId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/usersubnets": { "get": { "description": "List user-managed subnets that are bound to a cluster. Note that user-managed subnets are deprecated.", "tags": [ "clusters" ], "summary": "List user-managed subnets that are bound to a cluster.", "operationId": "GetClusterUserSubnet", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of user-managed subnets that are bound to your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VlanConfigField" }, "minItems": 0, "maxItems": 100 }, "example": [ { "id": "example-id-123", "region": "us-south", "subnets": [ { "cidr": "example-id-123", "id": "example-id-123", "ips": [ "example-value" ], "is_byoip": false, "is_public": false } ], "zone": "us-south-1" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "User-managed subnets for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-user-subnet.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/usersubnets\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Make your own private subnet available to an Kubernetes Service cluster. This private subnet is not one provided by IBM Cloud infrastructure (SoftLayer). As such, you must configure any inbound and outbound network traffic routing for the subnet.\nNote: User-managed subnets are deprecated. When you add a private user subnet to a cluster, IP addresses of this subnet are used for private Load Balancers in the cluster. To avoid IP address conflicts, make sure that you use a subnet with one cluster only. Do not use a subnet for multiple clusters or for other purposes outside of Kubernetes Service at the same time.", "tags": [ "clusters" ], "summary": "Add an existing user-managed subnet to a cluster.", "operationId": "AddClusterUserSubnet", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to make your user-managed subnet available to. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSubnet" } } }, "description": "Pass the CIDR of your user-managed subnet and the ID of an available private VLAN in the body.", "required": true }, "x-codegen-request-body-name": "UserSubnet", "responses": { "204": { "description": "Ok. The specified subnet was successfully made available to your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A user-managed subnet is added to the cluster.", "events": [ { "name": "containers-kubernetes.cluster-user-subnet.add" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/usersubnets\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cidr\": \"example-id-123\",\n", " \"vlan_id\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/usersubnets/{subnetId}/vlans/{vlanId}": { "delete": { "description": "Remove a private user-managed subnet from a cluster.\nNote: User-managed subnets are deprecated. Any service that was deployed to an IP address from your own private subnet remains active after the subnet is removed.", "tags": [ "clusters" ], "summary": "Remove a user-managed subnet from a cluster.", "operationId": "RemoveClusterUserSubnet", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to remove the user-managed subnet from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The GUID of the user-managed subnet that you want to remove from your cluster.", "name": "subnet_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the private VLAN that the user-managed subnet is on.", "name": "vlan_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The specified subnet was successfully removed from your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A user-managed subnet is removed from the cluster.", "events": [ { "name": "containers-kubernetes.vlan.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/clusters/{idOrName}/usersubnets/{subnetId}/vlans/{vlanId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/vlans/{vlanId}": { "post": { "description": "Create an IBM Cloud classic infrastructure subnet and make it available to an existing cluster.\nNote: When you make a subnet available to a cluster, IP addresses of this subnet are used for cluster networking purposes. To avoid IP address conflicts, make sure that you use a subnet with one cluster only. Do not use a subnet for multiple clusters or for other purposes outside of Kubernetes Service at the same time.", "tags": [ "clusters" ], "summary": "Create an IBM Cloud classic infrastructure subnet and add it to an existing c...", "operationId": "CreateClusterSubnet", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster for which you want to make an existing subnet from your IBM Cloud infrastructure account available. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The VLAN in which to create the subnet. To list available VLANs, use the `GET /v1/datacenters/{datacenter}/vlans` API or run `ibmcloud ks vlan ls `.", "name": "vlan_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The number of subnet IP addresses. The default value is 8. Accepted values are 8, 16, 32, 64.", "name": "size", "in": "query", "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The specified subnet was successfully made available to your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A subnet is created.", "events": [ { "name": "containers-kubernetes.subnet.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/vlans/{vlanId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/webhooks": { "get": { "description": "List all webhooks for a Kubernetes cluster.", "tags": [ "clusters" ], "summary": "List all webhooks for a cluster.", "operationId": "GetClusterWebhooks", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster for which you want to list available webhooks. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of available webhooks for the cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterWebhook" }, "minItems": 0, "maxItems": 100 }, "example": [ { "level": "example-value", "type": "example-value", "url": "https://example.com" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Webhooks, such as for Slack, for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-webhook.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/webhooks\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Add a webhook, such as for Slack, to a Kubernetes cluster.", "tags": [ "clusters" ], "summary": "Add a webhook to a cluster.", "operationId": "AddClusterWebhooks", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to add a webhook to. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterWebhook" } } }, "description": "Input parameter to create a webhook. Set `level` to the notification level, such as `Normal` or `Warning`. The default value is `Warning`. Set `type` to the webhook service type. Currently `slack` is supported. Set `url` to the URL for the webhook.", "required": true }, "x-codegen-request-body-name": "clusterWebhook", "responses": { "201": { "description": "Created. The webhook was successfully added to the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster webhook, such as for Slack, is created.", "events": [ { "name": "containers-kubernetes.cluster-webhook.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To get the action, the user must have the Editor platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/webhooks\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"level\": \"example-value\",\n", " \"type\": \"example-value\",\n", " \"url\": \"https://example.com\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/workerpools": { "get": { "description": "List all the worker pools that you have in a cluster.", "tags": [ "clusters" ], "summary": "List the worker pools in a cluster.", "operationId": "GetWorkerPoolsV1", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. The list of worker pools was successfully retrieved.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerPoolResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "autoscaleEnabled": true, "id": "example-id-123", "isBalanced": false, "isolation": "example-value", "labels": {}, "machineType": "example-value", "name": "my-cluster", "operatingSystem": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list all the clusters, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker pools for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/workerpools\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Create a worker pool for the specified cluster. Creating a worker pool requires Operator access to Kubernetes Service in the IBM Cloud account.", "tags": [ "clusters" ], "summary": "Create a worker pool for a cluster.", "operationId": "CreateWorkerPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerPoolRequest" } } }, "description": "The", "required": true }, "x-codegen-request-body-name": "workerPoolConfig", "responses": { "201": { "description": "Created. The worker pool was successfully created in for the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerPoolResponse" }, "example": { "autoscaleEnabled": true, "id": "example-id-123", "isBalanced": false, "isolation": "example-value", "labels": {}, "machineType": "example-value", "name": "my-cluster", "operatingSystem": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "409": { "description": "Conflict. A worker pool create may already be in progress for the provided cluster. Please wait a few minutes and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is created in the cluster.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/workerpools\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"diskEncryption\": false,\n", " \"entitlement\": \"example-value\",\n", " \"isolation\": \"example-value\",\n", " \"labels\": {},\n", " \"machineType\": \"example-value\",\n", " \"name\": \"my-cluster\",\n", " \"operatingSystem\": \"example-value\",\n", " \"sizePerZone\": 3\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/workerpools/{poolidOrName}": { "get": { "description": "View detailed information for a worker pool.", "tags": [ "clusters" ], "summary": "View details for a worker pool.", "operationId": "GetWorkerPoolV1", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "poolid_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker pool is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerPoolResponse" }, "example": { "autoscaleEnabled": true, "id": "example-id-123", "isBalanced": false, "isolation": "example-value", "labels": {}, "machineType": "example-value", "name": "my-cluster", "operatingSystem": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker pool could not be found. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls mycluster`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a worker pool in the cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/workerpools/{poolidOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "delete": { "description": "Remove a worker pool from a cluster. All worker nodes in the pool are deleted. Your pods are rescheduled when you delete. To avoid downtime, be sure that you have enough worker nodes in other worker pools to run your workload.", "tags": [ "clusters" ], "summary": "Remove a worker pool from a cluster.", "operationId": "RemoveWorkerPoolV1", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "poolid_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "OK. The request to remove your worker pool was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker pool could not be found. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls mycluster`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is deleted from the cluster.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/clusters/{idOrName}/workerpools/{poolidOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "patch": { "description": "To change the number of worker nodes in a worker pool, you can resize or rebalance the worker pool. When you resize the worker pool, you change the number of worker nodes that are created in each zone of the worker pool. For example, if you set the size per zone to 3 and have 3 zones in the pool, you have 9 worker nodes in total. When you rebalance the worker pool, you return the number of worker nodes in the worker pool to a balanced state. For example, if you remove some worker nodes such as to troubleshoot an issue, you might have an uneven number of nodes across zones. You might delete 2 worker nodes in zone dal13 but still have 3 worker nodes each in zones dal10 and dal12 for a total of 7 worker nodes. To fix this unbalanced state, rebalance the worker pool. After rebalancing, the worker pool has 9 worker nodes again. Rebalancing does not change the size per zone of the worker pool, even if you specify a different size per zone.", "tags": [ "clusters" ], "summary": "Resize or rebalance a worker pool.", "operationId": "PatchWorkerPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "poolid_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerPoolPatchRequest" } } }, "description": "You can change the number of worker nodes by resizing or rebalancing the worker pool. To resize, set parameters `\"state\"` to `\"resizing\"` and `\"sizePerZone\"` to the number of worker nodes that you want in each zone. You can also note why you resize the worker pool in the `\"reasonForResize\"` string parameter. To rebalance, set parameter `\"state\"` to `\"rebalancing\"`. Note that rebalancing does not change the size per zone of the worker pool. To apply a custom label to the worker pool, set the `\"state\"` field to `\"labels\"` and fill in the `\"labels\"` section with your label key-value pairs. When you apply a label, all existing custom labels are replaced. If you have existing custom labels that you want to keep, include them in your request. To remove a custom label, set the `\"state\"` field to `\"labels\"` and in the `\"labels\"` section, include the same `\"key\"` field, but leave the value field blank `\"\"`. Note that you must not edit the system-provided labels that that come with the worker pool and worker nodes by default, or you might experience unexpected results.", "required": true }, "x-codegen-request-body-name": "workerPoolSize", "responses": { "202": { "description": "OK. The request to resize your worker pool was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The request will not be permitted.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified worker pool could not be found. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The event that is generated depends on the operation that you request for the worker pool.", "events": [ { "description": "A worker pool is rebalanced.", "name": "containers-kubernetes.cluster-worker-pool.rebalance" }, { "description": "A worker pool is resized, to add or decrease the number of worker nodes in the pool.", "name": "containers-kubernetes.cluster-worker-pool.resize" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v1/clusters/{idOrName}/workerpools/{poolidOrName}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"allowSingleOpenShiftWorker\": false,\n", " \"labels\": {},\n", " \"reasonForResize\": \"example-value\",\n", " \"sizePerZone\": 3,\n", " \"state\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones": { "post": { "description": "Add a zone to the specified worker pool for a cluster. Worker nodes are created in each added zone, based on the requested size per zone of the worker pool details.", "tags": [ "clusters" ], "summary": "Add a zone to the specified worker pool for a cluster.", "operationId": "AddWorkerPoolZone", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "poolid_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerPoolZone" } } }, "description": "Input parameters to add zones to the worker pool.", "required": true }, "x-codegen-request-body-name": "workerZoneConfig", "responses": { "201": { "description": "OK. The requested zone has been added to the worker pool.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker pool could not be found. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls mycluster`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The provided zone already exists in the worker pool.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A zone is added to a worker pool.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool-zone.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"id\": \"example-id-123\",\n", " \"privateVlan\": \"example-value\",\n", " \"publicVlan\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones/{zoneid}": { "delete": { "description": "Remove a zone from a worker pool. All worker nodes for the zone are deleted from the worker pool. To avoid downtime for your apps, make sure that you have enough worker nodes left to reschedule your workloads.", "tags": [ "clusters" ], "summary": "Remove a zone from a worker pool.", "operationId": "RemoveWorkerPoolZoneV1", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "poolid_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the zone that you want to remove from the worker pool. To list all worker pools for a cluster, use the `GET /v1/zones` API or run `ibmcloud ks zone ls`.", "name": "zoneid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "OK. The request to remove the zone from your worker pool was successfully submitted.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The request will not be permitted.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified worker pool or zone could not be found. To list all worker pool zones, use the `GET /v1/clusters/{idOrName}/workerpools/{poolIdOrName}/zones` API or run `ibmcloud ks worker-pool ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A zone is deleted from a worker pool.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool-zone.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones/example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "patch": { "tags": [ "clusters" ], "summary": "Update the network configuration details, such as VLANs, for a zone in the wo...", "operationId": "AddWorkerPoolZoneNetwork", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "poolid_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool zone. To list all worker pools for a cluster, use the `GET /v1/zones` API or run `ibmcloud ks zone ls`.", "name": "zoneid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerPoolZonePatchRequest" } } }, "description": "Updated network configuration values for the worker pool zone.", "required": true }, "x-codegen-request-body-name": "workerPoolZone", "responses": { "204": { "description": "OK. The request to update network configuration for your worker pool was successful.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The request will not be permitted.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified worker pool or zone could not be found. To list all worker pool zones, use the `GET /v1/clusters/{idOrName}/workerpools/{poolIdOrName}/zones` API or run `ibmcloud ks worker-pool ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The networking data, such as public and private VLAN data, is added for a zone that the worker pool spans.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool-zone-network.add" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v1/clusters/{idOrName}/workerpools/{poolidOrName}/zones/example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"privateVlan\": \"example-value\",\n", " \"publicVlan\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/workers": { "get": { "description": "List all worker nodes and the status of each in a cluster.", "tags": [ "clusters" ], "summary": "List all worker nodes in a cluster.", "operationId": "GetClusterWorkers", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the worker pool to filter results for. Run `ibmcloud ks worker-pool ls --cluster `.", "name": "pool", "in": "query", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster for which you want to list all worker nodes. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "true|false Shows deleted workers", "name": "show_deleted", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of worker nodes for the specified cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Worker" }, "minItems": 0, "maxItems": 100 }, "example": [ { "errorMessage": "example-value", "errorMessageDate": "example-value", "id": "example-id-123", "isolation": "example-value", "kubeVersion": "1.28.5", "location": "us-south", "machineType": "example-value", "masterVersionEOS": "1.28.5" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker nodes for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/workers\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Add additional worker nodes to a Kubernetes cluster. Note that adding stand-alone worker nodes is deprecated. Instead, resize the worker pool to add worker nodes.", "tags": [ "clusters" ], "summary": "Add worker nodes to a cluster.", "operationId": "AddClusterWorkers", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster to which you want to add additional worker nodes. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerConfig" } } }, "description": "Input parameter to add workers to a cluster. For more information, see https://ibm.biz/worker_add_docs", "required": true }, "x-codegen-request-body-name": "workerConfig", "responses": { "201": { "description": "Ok. Additional worker nodes were successfully added to your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker node is added to the cluster.", "events": [ { "name": "containers-kubernetes.cluster-worker.add" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/clusters/{idOrName}/workers\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"dataCenter\": \"example-value\",\n", " \"diskEncryption\": false,\n", " \"isolation\": \"example-value\",\n", " \"machineType\": \"example-value\",\n", " \"operatingSystem\": \"example-value\",\n", " \"prefix\": \"example-value\",\n", " \"privateVlan\": \"example-value\",\n", " \"publicVlan\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/clusters/{idOrName}/workers/{workerId}": { "get": { "description": "View detailed information for a worker node.", "tags": [ "clusters" ], "summary": "View details of a worker node.", "operationId": "GetWorkerV1", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node that you want details for. To list all worker nodes for a cluster, use the `GET /v1/clusters/{idOrName}/workers` API or run `ibmcloud ks worker ls --cluster `.", "name": "worker_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker node is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Worker" }, "example": { "errorMessage": "example-value", "errorMessageDate": "example-value", "id": "example-id-123", "isolation": "example-value", "kubeVersion": "1.28.5", "location": "us-south", "machineType": "example-value", "masterVersionEOS": "1.28.5" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "View details of a worker node in the cluster.", "events": [ { "name": "containers-kubernetes.worker.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/clusters/{idOrName}/workers/{workerId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "put": { "description": "Reboot, reload, or update a worker node in a Kubernetes cluster. If a problem exists with a worker node, try to reload it, which reloads all the configurations and updates the worker node with the latest image and Kubernetes patch version. When you reboot a worker node, its state remains the same such as `deployed`, but its status updates as the machine in your infrastructure account is restarted. If you update the worker node, it is reimaged with the Kubernetes version that matches the cluster master. If you reboot, reload, or update a worker node, data is deleted if not stored outside the worker node in persistent storage. This action cannot be undone.", "tags": [ "clusters" ], "summary": "Reboot, reload, or update a worker node for a cluster.", "operationId": "UpdateClusterWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node. To list all worker nodes for a cluster, use the `GET /v1/clusters/{idOrName}/workers` API or run `ibmcloud ks worker ls --cluster `.", "name": "worker_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkerCommand" } } }, "description": "The action that you want your worker node to take. Pass `os_reboot`, `reload`, or `update` as the action string.", "required": true }, "x-codegen-request-body-name": "apiCommand", "responses": { "204": { "description": "OK. The request to reboot or reload your worker node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The event that is generated depends on the operation that you request for the worker node.", "events": [ { "description": "A worker node is rebooted. A reboot clears temporary directories, but does not clear the entire file system or reformat the disks. Generated if `os_reboot` is passed for the `apiCommand` parameter.", "name": "containers-kubernetes.worker.reboot" }, { "description": "A worker node is reloaded. The worker node is updated with the latest image and patch version. Any data stored locally on the worker node is deleted. Generated if `reload` is passed for the `apiCommand` parameter.", "name": "containers-kubernetes.worker.reload" }, { "description": "A worker node version is update, such as a minor version update to match the cluster master version. Generated if `update` is passed for the `apiCommand` parameter.", "name": "containers-kubernetes.worker.reboot" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/clusters/{idOrName}/workers/{workerId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"action\": \"example-value\",\n", " \"force\": false\n", "}'\n" ] } ] } ] } } }, "delete": { "description": "Delete a worker node from a cluster. This action cannot be undone. When you delete the worker node, the worker node is cordoned and drained so that its pods are rescheduled onto remaining worker nodes in the cluster. Make sure that you have enough capacity in the cluster to support the workload. After you remove the worker node, you can rebalance the worker pool.", "tags": [ "clusters" ], "summary": "Delete a worker node from a cluster.", "operationId": "RemoveClusterWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster to add additional worker nodes to. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node. To list all worker nodes for a cluster, use the `GET /v1/clusters/{idOrName}/workers` API or run `ibmcloud ks worker ls --cluster `.", "name": "worker_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The worker node was successfully removed from your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker node is deleted from the cluster.", "events": [ { "name": "containers-kubernetes.worker.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/clusters/{idOrName}/workers/{workerId}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/config": { "get": { "description": "List account configuration information that you can use when making IBM Cloud API requests.", "tags": [ "util" ], "summary": "List configuration values for your IBM Cloud account.", "operationId": "GetBluemixConfig", "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BluemixConfig" }, "example": { "accounts_url": "https://example.com", "acct_url": "https://example.com", "bluemix_url": "https://example.com", "env_name": "my-cluster", "iam_base_url": "https://example.com", "iam_client_id": "example-id-123", "iam_client_secret": "example-value", "iam_issuer": "example-value" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/config\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/credentials": { "get": { "description": "Get the infrastructure user name of the credentials that are used to access the IBM Cloud classic infrastructure portfolio. Infrastructure credentials are set per region and resource group.", "tags": [ "accounts" ], "summary": "View the IBM Cloud classic infrastructure account credentials that are set fo...", "operationId": "GetUserCredentials", "parameters": [ { "description": "Target the IBM Cloud Kubernetes Service region where you want to get infrastructure credential details. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The IBM Cloud infrastructure (SoftLayer) account credentials were successfully retrieved from IBM Cloud Kubernetes Service.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credentials" }, "example": { "apiUser": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. No IBM Cloud infrastructure account credentials are stored in the Kubernetes Service account for this region and resource group.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Details on the classic infrastructure credentials that are set for managing clusters in the region and resource group are returned.", "events": [ { "name": "containers-kubernetes.account-infra-credential.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/credentials\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Set the IBM Cloud classic infrastructure user name and API key for the region and resource group in your IBM Cloud Kubernetes Service account. Do not set multiple credentials for one IBM Cloud Kubernetes Service account. Every IBM Cloud Kubernetes Service account is linked to one IBM Cloud infrastructure portfolio only. When you manually set infrastructure credentials with this API, these credentials are used instead of any API key that is set for the region and resource group.", "tags": [ "accounts" ], "summary": "Set IBM Cloud classic infrastructure account credentials for your IBM Cloud K...", "operationId": "StoreUserCredentials", "parameters": [ { "description": "Target the IBM Cloud Kubernetes Service region where you want to set infrastructure credentials. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The user name of the IBM Cloud classic infrastructure account that you want to use with Kubernetes Service. To retrieve your user name, log in to the IBM Cloud account that you want to use, click Manage > Access (IAM) > Users > your user profile. Then, from the User Details tab, go to the VPN password section. The user name is in a format similar to 1234567_name@email.com.", "name": "X-Auth-Softlayer-Username", "in": "header", "schema": { "type": "string" } }, { "description": "The classic infrastructure API key of the IBM Cloud account that you want to use with Kubernetes Service. To retrieve your API key, log in to the IBM Cloud account that you want to use, click Manage > Access (IAM) > API keys. Filter the view for Classic infrastructure API keys. In the row for the API key, click the action menu > Details. In the API key details pane, click the eye icon to view the API key value.", "name": "X-Auth-Softlayer-APIKey", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The IBM Cloud infrastructure account credentials were successfully set for this region and resource group.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Classic infrastructure credentials for managing clusters in the region and resource group are set.", "events": [ { "name": "containers-kubernetes.account-infra-credential.set" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/credentials\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "delete": { "description": "Remove the IBM Cloud classic infrastructure user name and API key from the region and resource group in your IBM Cloud Kubernetes Service account. After removing the credentials, you cannot access that IBM Cloud classic infrastructure account through your IBM Cloud Kubernetes Service account anymore. Instead, the default infrastructure account for your IBM Cloud account and the corresponding API key is used.\nBefore you remove the infrastructure credentials, check which clusters use these credentials and make a plan to re-create the clusters in the new infrastructure environment. Otherwise, you might not be able to perform infrastructure actions, like updating or adding worker nodes, to the clusters that use the old credentials.", "tags": [ "accounts" ], "summary": "Remove IBM Cloud classic infrastructure account credentials from your IBM Clo...", "operationId": "RemoveUserCredentials", "parameters": [ { "description": "Target the IBM Cloud Kubernetes Service region where you want to remove infrastructure credentials. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The IBM Cloud infrastructure account credentials were successfully removed from your IBM Cloud Kubernetes Service account for this region and resource group.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. No IBM Cloud infrastructure account credentials are stored in the Kubernetes Service account for this region and resource group.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Classic infrastructure credentials for managing clusters in the region and resource group are deleted.", "events": [ { "name": "containers-kubernetes.account-infra-credential.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/credentials\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/datacenters/{datacenter}/machine-types": { "get": { "description": "List available machine types that you can use for a worker node. Machine types vary by zone. Each machine type includes the amount of virtual CPU, memory, and disk space that is set up for the worker node. For more information, see http://ibm.biz/machine_types", "tags": [ "util" ], "summary": "List available machine types for a zone (data center).", "operationId": "GetDatacenterMachineTypes", "parameters": [ { "description": "The zone ID where you want to list available machine types. To list available zones, run `ibmcloud ks zone ls` or use the `GET /v1/datacenters` API.", "name": "datacenter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineTypes" }, "example": [ { "cores": "example-value", "correspondingMachineType": "example-value", "deprecated": false, "gpus": "example-value", "isTrusted": false, "memory": "example-value", "name": "my-cluster", "networkSpeed": "example-value" } ] } } }, "400": { "description": "The specified zone is invalid. To list available zones, run `ibmcloud ks zone ls` or use the `GET /v1/datacenters` API.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/datacenters/example-value/machine-types\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/datacenters/{datacenter}/vlans": { "get": { "description": "List available public and private VLANs for a specified data center. Before using this operation, you must store your IBM Cloud infrastructure (SoftLayer) credentials in each Kubernetes Service account by using the `POST /v1/credentials` API or by running `ibmcloud ks credential set --infrastructure-api-key --infrastructure-username `.", "tags": [ "properties" ], "summary": "List available VLANs for a zone.", "operationId": "GetDatacenterVLANs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the zone where you want to list available public and private VLANs. To list available zones, run `ibmcloud ks zone ls` or use the `GET /v1/datacenters` API.", "name": "datacenter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of available public and private VLANs for the specified zone is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VLAN" }, "minItems": 0, "maxItems": 100 }, "example": [ { "id": "example-id-123", "properties": { "local_disk_storage_capability": "example-value", "location": "us-south", "name": "my-cluster", "note": "example-value", "primary_router": "example-value", "san_storage_capability": "example-value", "subnet_count": 3, "vlan_number": "example-value" }, "type": "example-value" } ] } } }, "400": { "description": "The specified zone is invalid. To list available zones, run `ibmcloud ks zone ls' or use the `GET /v1/datacenters` API.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "VLANs in an IBM Cloud account for a particular data center are listed.", "events": [ { "name": "containers-kubernetes.account-datacenter-vlan.list" } ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/datacenters/example-value/vlans\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/infra-permissions": { "get": { "description": "Get details on the compute, networking, and storage permissions that the IBM Cloud infrastructure (SoftLayer) credentials have in this region and resource group. To review what IBM Cloud infrastructure (SoftLayer) credentials are set, use the `GET /v1/credentials` API, or run `ibmcloud ks credential get` or `ibmcloud ks api-key info`.", "tags": [ "accounts" ], "summary": "Get details on the permissions that the IBM Cloud infrastructure (SoftLayer) ...", "operationId": "GetInfraPermissions", "parameters": [ { "description": "Target the IBM Cloud Kubernetes Service region where you want to check the infrastructure permissions. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountStatus" }, "example": { "account": "example-value", "accountType": "example-value", "networkManagerPermissions": { "recommended": { "insufficient": false, "missingPermissions": [ "example-value" ] }, "required": { "insufficient": false, "missingPermissions": [ "example-value" ] } }, "physicalWorkerManagerPermissions": { "recommended": { "insufficient": false, "missingPermissions": [ "example-value" ] }, "required": { "insufficient": false, "missingPermissions": [ "example-value" ] } }, "storageManagerPermissions": { "recommended": { "insufficient": false, "missingPermissions": [ "example-value" ] }, "required": { "insufficient": false, "missingPermissions": [ "example-value" ] } }, "virtualWorkerManagerPermissions": { "recommended": { "insufficient": false, "missingPermissions": [ "example-value" ] }, "required": { "insufficient": false, "missingPermissions": [ "example-value" ] } } } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Details on the compute, networking, and storage classic infrastructure permissions that are set for managing clusters in the region and resource group are returned.", "events": [ { "name": "containers-kubernetes.account-infra-permission.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/infra-permissions\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/keys": { "post": { "description": "Replace the IAM API key for the IBM Cloud Kubernetes Service in a region and resource group. The API key is used to access several services, such as the IBM Cloud classic infratructure portfolio, and is required to manage your clusters. To avoid service interruptions, do not replace the API key unless your existing key is compromised.", "tags": [ "accounts" ], "summary": "Reset the IAM API key.", "operationId": "ResetUserAPIKey", "parameters": [ { "description": "Target the IBM Cloud Kubernetes Service region where you want to reset the IAM API key. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group where you want to set the API key.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Ok. The IAM API key is successfully reset.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The API key that is used for all clusters in the region and resource group is set to the requesting user's API key credentials.", "events": [ { "name": "containers-kubernetes.account-api-key.reset" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/keys\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/kube-versions": { "get": { "description": "List available Kubernetes versions that you can use to create a cluster.\nNote: This API call is deprecated. Use the `GET /v1/versions` API instead.", "tags": [ "util" ], "summary": "Deprecated: List available Kubernetes versions.", "operationId": "GetKubeVersions", "responses": { "200": { "description": "Success. A list of available BOM versions is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KubeVersion" }, "minItems": 0, "maxItems": 100 }, "example": [ { "default": false, "end_of_service": "example-value", "major": 1, "minor": 1, "patch": 1 } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/kube-versions\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/locations": { "get": { "description": "List locations from the IBM Cloud catalog that are supported by the IBM Cloud Kubernetes Service.", "tags": [ "util" ], "summary": "List available locations.", "operationId": "ListLocations", "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IKSLocation" }, "minItems": 0, "maxItems": 100 }, "example": [ { "country": "example-value", "display_name": "my-cluster", "geography": "example-value", "id": "example-id-123", "kind": "example-value", "metro": "example-value", "multizone_metro": "us-south-1", "name": "my-cluster" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/locations\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/clusterkeyowner": { "get": { "description": "View the name and email address for the owner of the cluster's containers-kubernetes-key API key.", "tags": [ "logging" ], "summary": "View information about the containers-kubernetes-key API key owner.", "operationId": "GetClusterKeyOwner", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The cluster API key ID and the owner's name and email address.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterKeyOwnerInfo" }, "example": { "email": "example-value", "id": "example-id-123", "name": "my-cluster" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/logging/{idOrName}/clusterkeyowner\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/default": { "get": { "description": "View the default logging endpoint for the target region.", "tags": [ "logging" ], "summary": "View the default logging endpoint for the target region.", "operationId": "GetDefaultLoggingEndpoint", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The default logging endpoint for the target region.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultLoggingEndpointResponse" }, "example": { "endpoint": "https://example.com", "hostname": "my-cluster", "port": 443 } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/logging/{idOrName}/default\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/filterconfigs": { "get": { "description": "List the logging filter configurations that you created in a cluster.", "tags": [ "filter" ], "summary": "List all logging filter configurations in the cluster.", "operationId": "FetchFilterConfigs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Set to true to populate global filters with all matching logging configurations.", "name": "show_matches", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok. A list of logging filters in the cluster.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/FilterConfigResponse" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/logging/{idOrName}/filterconfigs\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Start filtering logs that are forwarded by your logging configuration from the given sources based on one or more selectors.", "tags": [ "filter" ], "summary": "Create a logging filter configuration.", "operationId": "CreateFilterConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConfigBody" } } }, "description": "The new logging filter configuration.", "required": true }, "x-codegen-request-body-name": "filterConfig", "responses": { "201": { "description": "Ok. Logs from the specified logging configurations will be filtered on the provided selectors.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConfigResponse" }, "example": { "container": "example-value", "coveringFilters": [ "example-value" ], "id": "example-id-123", "label": "example-value", "logLevel": "example-value", "loggingConfigs": [ "example-value" ], "message": "example-value", "namespace": "my-cluster" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all of the required parameters, formatted in JSON. Supported logging types are 'syslog' and 'ibm'. Log forwarding is not supported for the 'ibm-system' and 'kube-system' namespaces.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/logging/{idOrName}/filterconfigs\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"container\": \"example-value\",\n", " \"logLevel\": \"example-value\",\n", " \"loggingConfigs\": [\n", " \"example-value\"\n", " ],\n", " \"message\": \"example-value\",\n", " \"namespace\": \"my-cluster\",\n", " \"regexMessageEnabled\": true,\n", " \"type\": \"example-value\"\n", "}'\n" ] } ] } ] } } }, "delete": { "description": "Stops log filtering.", "tags": [ "filter" ], "summary": "Deletes all logging filter configurations for the cluster.", "operationId": "DeleteFilterConfigs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Ok. All log filtering configurations have been removed.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/logging/{idOrName}/filterconfigs\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/filterconfigs/{id}": { "get": { "description": "View details for a logging filter configuration.", "tags": [ "filter" ], "summary": "View a logging filter configuration.", "operationId": "FetchFilterConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The UUID of the logging filter that you want to fetch.", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "To show matching logging configurations for global filters, set to `true`.", "name": "show_matches", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok. A logging filter is configured for your cluster.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FilterConfigResponse" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "example": {} } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/logging/{idOrName}/filterconfigs/example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "put": { "description": "Update a logging filter config where `id` is the UUID for the filter config.", "tags": [ "filter" ], "summary": "Update a logging filter configuration.", "operationId": "UpdateFilterConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The UUID for the filterConfig that you want to update.", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConfigBody" } } }, "description": "The new filter configuration for the specified ID.", "required": true }, "x-codegen-request-body-name": "filterConfig", "responses": { "200": { "description": "Ok. The configuration was updated.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterConfigResponse" }, "example": { "container": "example-value", "coveringFilters": [ "example-value" ], "id": "example-id-123", "label": "example-value", "logLevel": "example-value", "loggingConfigs": [ "example-value" ], "message": "example-value", "namespace": "my-cluster" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all of the required parameters, formatted in JSON. Supported logging types are 'syslog'. Log forwarding is not supported for the 'ibm-system' and 'kube-system' namespaces.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/logging/{idOrName}/filterconfigs/example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"container\": \"example-value\",\n", " \"logLevel\": \"example-value\",\n", " \"loggingConfigs\": [\n", " \"example-value\"\n", " ],\n", " \"message\": \"example-value\",\n", " \"namespace\": \"my-cluster\",\n", " \"regexMessageEnabled\": true,\n", " \"type\": \"example-value\"\n", "}'\n" ] } ] } ] } } }, "delete": { "description": "Delete the specified logging filter configuration for a cluster.", "tags": [ "filter" ], "summary": "Delete a logging filter configuration.", "operationId": "DeleteFilterConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The UUID for the filterConfig that you want to delete.", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Ok. Logs will no longer be filtered by the specified filter configuration.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/logging/{idOrName}/filterconfigs/example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/loggingconfig": { "get": { "description": "List the log forwarding configurations in the target cluster.", "tags": [ "logging" ], "summary": "List all log forwarding configurations in the cluster.", "operationId": "FetchLoggingConfigs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of logging configurations in the Kubernetes cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LogConfigResponse" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/logging/{idOrName}/loggingconfig\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "delete": { "description": "Stops all log forwarding for a cluster by deleting all log forwarding configurations.", "tags": [ "logging" ], "summary": "Delete all log forwarding configurations for a cluster.", "operationId": "DeleteLoggingConfigs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Ok. All log forwarding configurations have been removed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/logging/{idOrName}/loggingconfig\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/loggingconfig/{logSource}": { "get": { "description": "List the log forwarding configurations for the specified log source in the target cluster.", "tags": [ "logging" ], "summary": "List all log forwarding configurations for a log source in the cluster.", "operationId": "FetchLoggingConfigsForSource", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The type of log source that you want to list configurations for.", "name": "log_source", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of logging configurations for the specified log source in the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LogConfigResponse" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/logging/{idOrName}/loggingconfig/{logSource}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "post": { "description": "Enable log collection for a specified log source and log forwarding to IBM Cloud Log Analysis or to an external syslog server. If you want to forward logs from one log source to both log collector servers, then you must create two logging configurations.", "tags": [ "logging" ], "summary": "Create a log forwarding configuration.", "operationId": "CreateLoggingConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The log source from which you want to forward logs. Accepted values are `container`, `worker`, `kubernetes`, `ingress`, and `application`. If you do not provide a namespace for log source `container`, then all namespaces use this configuration.", "name": "log_source", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } }, { "description": "Set to `true` to skip validation of the space and org Cloud Foundry properties. Skipping validation decreases processing time, but an invalid logging configuration will not correctly forward logs.", "name": "skip_validation", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogConfigBody" } } }, "description": "The type of log collector server for the logging configuration. Supported logging types are 'syslog' and 'ibm'.", "required": true }, "x-codegen-request-body-name": "loggingConfig", "responses": { "201": { "description": "Ok. Logs from the specified log source will be forwarded to the log server.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogConfigResponse" }, "example": { "appLogContainers": [ "example-value" ], "appLogPaths": [ "example-value" ], "caCert": "example-value", "endpoint": "https://example.com", "errors": [ "example-value" ], "id": "example-id-123", "logSource": "example-value", "logSourceContainers": [ "example-value" ] } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. Supported logging types are 'syslog' and 'ibm'. Log forwarding is not supported for the 'ibm-system' and 'kube-system' namespaces.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/logging/{idOrName}/loggingconfig/{logSource}\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"appLogContainers\": [\n", " \"example-value\"\n", " ],\n", " \"appLogPaths\": [\n", " \"example-value\"\n", " ],\n", " \"caCert\": \"example-value\",\n", " \"loggingType\": \"example-value\",\n", " \"namespace\": \"my-cluster\",\n", " \"org\": \"example-value\",\n", " \"protocol\": \"example-value\",\n", " \"remoteLogPort\": 443\n", "}'\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/loggingconfig/{logSource}/{id}": { "put": { "description": "Update the details of a log forwarding configuration.", "tags": [ "logging" ], "summary": "Update a log forwarding configuration.", "operationId": "UpdateLoggingConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The log source from which you want to forward logs. Supported values are `container`, `worker`, `kubernetes`, `ingress`, and `application`. If you do not provide a namespace for log source `container`, then all namespaces use this configuration.", "name": "log_source", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The UUID of the logging configuration that you want to update.", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } }, { "description": "Set to `true` to skip validation of the space and org Cloud Foundry properties. Skipping validation decreases processing time, but an invalid logging configuration will not correctly forward logs.", "name": "skip_validation", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogConfigBody" } } }, "description": "The new type of log collector server for the logging configuration. Supported logging types are 'syslog'.", "required": true }, "x-codegen-request-body-name": "loggingConfig", "responses": { "200": { "description": "Ok. The configuration was updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogConfigResponse" }, "example": { "appLogContainers": [ "example-value" ], "appLogPaths": [ "example-value" ], "caCert": "example-value", "endpoint": "https://example.com", "errors": [ "example-value" ], "id": "example-id-123", "logSource": "example-value", "logSourceContainers": [ "example-value" ] } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. Supported logging types are 'syslog'. Log forwarding is not supported for the 'ibm-system' and 'kube-system' namespaces.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/logging/{idOrName}/loggingconfig/{logSource}/example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"appLogContainers\": [\n", " \"example-value\"\n", " ],\n", " \"appLogPaths\": [\n", " \"example-value\"\n", " ],\n", " \"caCert\": \"example-value\",\n", " \"loggingType\": \"example-value\",\n", " \"namespace\": \"my-cluster\",\n", " \"org\": \"example-value\",\n", " \"protocol\": \"example-value\",\n", " \"remoteLogPort\": 443\n", "}'\n" ] } ] } ] } } }, "delete": { "description": "Stops log forwarding by deleting a specified logging configuration.", "tags": [ "logging" ], "summary": "Delete a log forwarding configuration.", "operationId": "DeleteLoggingConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The log source that you want to stop forwarding logs for.", "name": "log_source", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The UUID of the logging configuration that you want to delete.", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Ok. Logs will no longer be forwarded to the log server for the specified logging configuration.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/logging/{idOrName}/loggingconfig/{logSource}/example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/refresh": { "put": { "description": "Refresh the logging configuration for a cluster. This refreshes the logging token for any logging configuration that is forwarding to the space level in your cluster.", "tags": [ "logging" ], "summary": "Refresh the cluster's logging configuration.", "operationId": "RefreshLoggingConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Forces the request which may cause a new fluentd version to be deployed to the cluster.", "name": "force_update", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Ok. A request was sent for the cluster's logging configuration to be refreshed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/logging/{idOrName}/refresh\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/logging/{idOrName}/updatepolicy": { "get": { "description": "Check if automatic updates for the Fluentd logging add-on are enabled and whether your Fluentd pods are updated to the latest version.", "tags": [ "logging" ], "summary": "Check if automatic updates for the Fluentd logging add-on are enabled in the ...", "operationId": "GetFluentdUpdatePolicy", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The current update policy.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePolicy" }, "example": { "autoUpdate": false, "latestVersion": false } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. Supported logging types are 'syslog' and 'ibm'. Log forwarding is not supported for the 'ibm-system' and 'kube-system' namespaces.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/logging/{idOrName}/updatepolicy\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } }, "put": { "description": "By default, automatic updates to the Fluentd logging add-on are enabled. Fluentd pods are automatically updated when a new version is available. To instead update the add-on manually, you can use this call to disable automatic updates. If automatic updates for the Fluentd add-on are disabled, you can re-enable automatic updates. Whenever the next version becomes available, the Fluentd pods are automatically updated to the latest version.", "tags": [ "logging" ], "summary": "Enable or diable automatic updates for the Fluentd logging add-on in the clus...", "operationId": "ChangeFluentdUpdatePolicy", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the target cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePolicy" } } }, "description": "The new update policy configuration", "required": true }, "x-codegen-request-body-name": "updatePolicy", "responses": { "204": { "description": "Ok. The logging update policy has been changed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. Supported logging types are 'syslog' and 'ibm'. Log forwarding is not supported for the 'ibm-system' and 'kube-system' namespaces.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. To retrieve your access tokens, be sure that you're logged in and run `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To see a list of your clusters, run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/logging/{idOrName}/updatepolicy\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"autoUpdate\": false,\n", " \"latestVersion\": false\n", "}'\n" ] } ] } ] } } } }, "/v1/messages": { "get": { "description": "View the current messages. Messages are notifications for new features or changes that may require attention.", "tags": [ "util" ], "summary": "View the current messages.", "operationId": "GetMessages", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "id": "example-id-123", "message": "example-value", "services": [ "example-value" ] } ] } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/messages\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/nlb-dns/clusters/{idOrName}/add": { "put": { "description": "Add an NLB IP address to an existing NLB subdomain that you created.\nFor example, in a multizone cluster, you create an NLB in each zone to expose an app. You registered an NLB IP in one zone with a subdomain by using the `POST /clusters/{idOrName}/register` call, so now you can add the NLB IPs from the other zones to this existing subdomain.", "tags": [ "ingress-nlb-dns" ], "summary": "Update a DNS record by adding an NLB IP address.", "operationId": "UpdateDNSWithIP", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbConfig" } } }, "description": "The input parameter to update an NLB DNS record. Include only the `nlbHost` parameter to specify the existing NLB subdomain and the `nlbIP` parameter to specify the NLB IP you want to add.", "required": true }, "x-codegen-request-body-name": "nlbDNSConfig", "responses": { "204": { "description": "Ok. The request to update the NLB subdomain was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster, NLB subdomain, or NLB IP address could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `. To list existing NLB IP addresses in a cluster, run `kubectl get svc -n `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/nlb-dns/clusters/{idOrName}/add\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"certProvider\": \"vpc-gen2\",\n", " \"clusterID\": \"example-id-123\",\n", " \"crn\": \"example-value\",\n", " \"isDefault\": false,\n", " \"nlbDnsType\": \"example-value\",\n", " \"nlbHost\": \"example-value\",\n", " \"nlbIPArray\": [\n", " \"example-value\"\n", " ],\n", " \"nlbMonitorState\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/nlb-dns/clusters/{idOrName}/health": { "put": { "description": "Enable or disable an existing health check monitor for an NLB subdomain.", "tags": [ "ingress-nlb-health-monitor" ], "summary": "Enable or disable a health check monitor for an NLB subdomain.", "operationId": "UpdateNlbDNSHealthMonitor", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbConfig" } } }, "description": "Include only the `nlbHost` parameter to specify the NLB subdomain and the `nlbMonitorState` parameter to specify the health check monitor as `enabled` or `disabled`.", "required": true }, "x-codegen-request-body-name": "nlbDNSConfig", "responses": { "200": { "description": "Ok. Health check monitor enable/disable request for successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or NLB subdomain could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v1/nlb-dns/clusters/{idOrName}/health\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"certProvider\": \"vpc-gen2\",\n", " \"clusterID\": \"example-id-123\",\n", " \"crn\": \"example-value\",\n", " \"isDefault\": false,\n", " \"nlbDnsType\": \"example-value\",\n", " \"nlbHost\": \"example-value\",\n", " \"nlbIPArray\": [\n", " \"example-value\"\n", " ],\n", " \"nlbMonitorState\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/nlb-dns/clusters/{idOrName}/host/{nlbHost}/ip/{nlbIP}/remove": { "delete": { "description": "Remove an IP address from the DNS record for an existing NLB subdomain. If you remove all IPs from a hostname, the hostname still exists but no IPs are associated with it.", "tags": [ "ingress-nlb-dns" ], "summary": "Remove an IP address from an NLB subdomain.", "operationId": "UnregisterDNSWithIP", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The existing NLB subdomain from which you want remove an NLB IP. To list existing NLB subdomains, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "name": "nlb_host", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The NLB IP address that you want to unregister from the DNS record for the hostname. To list the NLB IPs registered with NLB subdomains, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "name": "nlb_ip", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted. The NLB IP address was successfully unregistered from the DNS record for the NLB subdomain.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster, NLB subdomain, or NLB IP address could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains and the NLB IPs registered with those hostnames, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v1/nlb-dns/clusters/{idOrName}/host/{nlbHost}/ip/{nlbIP}/remove\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/nlb-dns/clusters/{idOrName}/list": { "get": { "description": "In a classic cluster, list NLB subdomains and the NLB IP addresses registered with the DNS provider for each subdomain.", "tags": [ "ingress-nlb-dns" ], "summary": "List registered NLB subdomains and NLB IP addresses.", "operationId": "ListNLBIPsForSubdomain", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of NLB subdomains and the NLB IPs associated with the DNS record for the subdomains is returned for this cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterNlbHostsList" }, "example": { "clusterid": "example-id-123", "nlbHealthCheckConfigs": [ { "clusterID": "example-id-123", "healthCheckStatus": "example-value", "nlbHost": "example-value", "path": "example-value", "port": 443, "type": "example-value" } ], "nlbHealthCheckStatus": [ { "clusterID": "example-id-123", "monitorState": "example-value", "monitorStatus": "example-value", "nlbHost": "example-value", "nlbIP": "example-value" } ], "nlbs": [ { "certProvider": "vpc-gen2", "clusterID": "example-id-123", "crn": "example-value", "isDefault": false, "nlbDnsType": "example-value", "nlbHost": "example-value", "nlbIPArray": [ "example-value" ], "nlbMonitorState": "example-value" } ] } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/nlb-dns/clusters/{idOrName}/list\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/nlb-dns/clusters/{idOrName}/register": { "post": { "description": "Create a new NLB subdomain and register NLB IP addresses with the DNS provider. If the registration fails, an error from the DNS provider is returned.", "tags": [ "ingress-nlb-dns" ], "summary": "Create a new NLB subdomain and associate one or more NLB IP addresses with it.", "operationId": "RegisterDNSWithIP", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbConfig" } } }, "description": "Include either the `nlbIP` or the `nlbIPArray` parameter that specifies the NLB IP address(es) that you want to register.", "required": true }, "x-codegen-request-body-name": "nlbDNSConfig", "responses": { "201": { "description": "Created. The NLB subdomain was successfully created and the NLB IP addres(es) registered with DNS.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbConfig" }, "example": { "certProvider": "vpc-gen2", "clusterID": "example-id-123", "crn": "example-value", "isDefault": false, "nlbDnsType": "example-value", "nlbHost": "example-value", "nlbIPArray": [ "example-value" ], "nlbMonitorState": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or NLB IP address could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB IP addresses in a cluster, run `kubectl get svc -n `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. 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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v1/nlb-dns/clusters/{idOrName}/register\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"certProvider\": \"vpc-gen2\",\n", " \"clusterID\": \"example-id-123\",\n", " \"crn\": \"example-value\",\n", " \"isDefault\": false,\n", " \"nlbDnsType\": \"example-value\",\n", " \"nlbHost\": \"example-value\",\n", " \"nlbIPArray\": [\n", " \"example-value\"\n", " ],\n", " \"nlbMonitorState\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/nlb-dns/health/clusters/{idOrName}/config": { "patch": { "description": "Create and optionally enable a health check monitor for an existing NLB subdomain in a cluster.", "tags": [ "ingress-nlb-health-monitor" ], "summary": "Configure a health check monitor for an NLB subdomain.", "operationId": "AddNlbDNSHealthMonitor", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbHealthSetConfig" } } }, "description": "The input body to configure the health check monitor for an NLB subdomain. To enable the health check monitor, set `monitorState` to `enabled`. For more information about each `healthcheckProperties` parameter, see https://cloud.ibm.com/docs/containers?topic=containers-cli-plugin-kubernetes-service-cli#cs_nlb-dns-monitor-configure", "required": true }, "x-codegen-request-body-name": "nlbHealthCheckData", "responses": { "201": { "description": "Created. The health check monitor was successfully configured for the NLB subdomain.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbHealthConfig" }, "example": { "allowInsecureSet": "example-value", "clusterID": "example-id-123", "createdOn": "example-value", "desc": "example-value", "followRedirectSet": "example-value", "healtcheckPropertiesSetStatus": "example-value", "healthcheckProperties": { "allow_insecure": true, "expectedBody": "example-value", "expectedCodes": "example-value", "follow_redirects": false, "header": {}, "interval": 1, "method": "example-value", "name": "my-cluster" }, "modifiedOn": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or NLB subdomain could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v1/nlb-dns/health/clusters/{idOrName}/config\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"allowInsecureSet\": \"example-value\",\n", " \"clusterID\": \"example-id-123\",\n", " \"createdOn\": \"example-value\",\n", " \"desc\": \"example-value\",\n", " \"followRedirectSet\": \"example-value\",\n", " \"healtcheckPropertiesSetStatus\": \"example-value\",\n", " \"healthcheckProperties\": {},\n", " \"modifiedOn\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v1/nlb-dns/health/clusters/{idOrName}/host/{nlbHost}/config": { "get": { "description": "View the health check monitor settings for an NLB subdomain.", "tags": [ "ingress-nlb-health-monitor" ], "summary": "View the health check monitor settings for an NLB subdomain.", "operationId": "GetNlbDNSHealthMonitor", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "The NLB subdomain that you want health check monitor settings for. To list existing NLB subdomains, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "name": "nlb_host", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Health check monitor settings for the specified NLB subdomain are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbHealthConfig" }, "example": { "allowInsecureSet": "example-value", "clusterID": "example-id-123", "createdOn": "example-value", "desc": "example-value", "followRedirectSet": "example-value", "healtcheckPropertiesSetStatus": "example-value", "healthcheckProperties": { "allow_insecure": true, "expectedBody": "example-value", "expectedCodes": "example-value", "follow_redirects": false, "header": {}, "interval": 1, "method": "example-value", "name": "my-cluster" }, "modifiedOn": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or NLB subdomain could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/nlb-dns/health/clusters/{idOrName}/host/{nlbHost}/config\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/nlb-dns/health/clusters/{idOrName}/list": { "get": { "description": "List the settings for all existing health check monitors in a cluster.", "tags": [ "ingress-nlb-health-monitor" ], "summary": "List the health check monitor settings for all NLB subdomains.", "operationId": "ListNlbDNSHealthMonitors", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The health check monitor settings for each NLB subdomain in the cluster are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterNlbHostsList" }, "example": { "clusterid": "example-id-123", "nlbHealthCheckConfigs": [ { "clusterID": "example-id-123", "healthCheckStatus": "example-value", "nlbHost": "example-value", "path": "example-value", "port": 443, "type": "example-value" } ], "nlbHealthCheckStatus": [ { "clusterID": "example-id-123", "monitorState": "example-value", "monitorStatus": "example-value", "nlbHost": "example-value", "nlbIP": "example-value" } ], "nlbs": [ { "certProvider": "vpc-gen2", "clusterID": "example-id-123", "crn": "example-value", "isDefault": false, "nlbDnsType": "example-value", "nlbHost": "example-value", "nlbIPArray": [ "example-value" ], "nlbMonitorState": "example-value" } ] } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/nlb-dns/health/clusters/{idOrName}/list\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/nlb-dns/health/clusters/{idOrName}/status": { "get": { "description": "Deprecated: List the health check status (`healthy` or `not healthy`) that is returned by the monitors for the IPs behind all NLB subdomains in a cluster.", "tags": [ "ingress-nlb-health-monitor" ], "summary": "Deprecated: List the health check status for the IPs behind NLB subdomains in...", "operationId": "ListNlbDNSHealthMonitorStatus", "deprecated": true, "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "id_or_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. An array that contains the NlbHealthCheckStatus is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterNlbHostsList" }, "example": { "clusterid": "example-id-123", "nlbHealthCheckConfigs": [ { "clusterID": "example-id-123", "healthCheckStatus": "example-value", "nlbHost": "example-value", "path": "example-value", "port": 443, "type": "example-value" } ], "nlbHealthCheckStatus": [ { "clusterID": "example-id-123", "monitorState": "example-value", "monitorStatus": "example-value", "nlbHost": "example-value", "nlbIP": "example-value" } ], "nlbs": [ { "certProvider": "vpc-gen2", "clusterID": "example-id-123", "crn": "example-value", "isDefault": false, "nlbDnsType": "example-value", "nlbHost": "example-value", "nlbIPArray": [ "example-value" ], "nlbMonitorState": "example-value" } ] } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/nlb-dns/health/clusters/{idOrName}/status\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/prodconfig": { "get": { "description": "List product-specific values to substitute for variables in other files.", "tags": [ "util" ], "summary": "List product-specific values to substitute for variables in other files.", "operationId": "GetProductConfig", "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductConfig" }, "example": { "company_name": "my-cluster", "container_service_name": "my-cluster", "iaas_name": "my-cluster", "product_name": "my-cluster", "product_name_short": "my-cluster" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/prodconfig\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/regions": { "get": { "description": "List available IBM Cloud Kubernetes Service regions. A region is a geographic area that is accessed by a container service endpoint.", "tags": [ "util" ], "summary": "Deprecated: List available Kubernetes Service regions.", "operationId": "GetRegions", "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regions" }, "example": { "regions": [ { "alias": "example-value", "cfURL": "https://example.com", "freeEnabled": true, "name": "my-cluster", "satellite": false } ] } } } }, "404": { "description": "Not found. The list of regions could not be found. Try your request again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/regions\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/subnets": { "get": { "description": "List available subnets in an IBM Cloud classic infrastructure account. Before using this operation, you must store your IBM Cloud classic infrastructure credentials in each Kubernetes Service account by using the `POST /v1/credentials` API or by running `ibmcloud ks credential set --infrastructure-api-key --infrastructure-username `.", "tags": [ "properties" ], "summary": "List available IBM Cloud classic infrastructure subnets.", "operationId": "ListSubnets", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "A comma seperated list of datacenters to filter subnets based off of.", "name": "datacenters", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subnet" }, "minItems": 0, "maxItems": 100 }, "example": [ { "availableIPv4AddressCount": 3, "id": "example-id-123", "ipv4CIDRBlock": "example-id-123", "name": "my-cluster", "publicGatewayID": "example-id-123", "publicGatewayName": "my-cluster", "vpcID": "example-id-123", "vpcName": "my-cluster" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Subnets in the IBM Cloud classic infrastructure account are listed.", "events": [ { "name": "containers-kubernetes.account-subnet.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/subnets\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/subnets/vlan-spanning": { "get": { "description": "View the VLAN spanning status for an IBM Cloud Infrastructure (SoftLayer) account. VLAN spanning enables all devices on an account to communicate with each other by means of the private network, regardless of its assigned VLAN.", "tags": [ "accounts" ], "summary": "View the VLAN spanning status.", "operationId": "GetVlanSpanning", "parameters": [ { "description": "Target the IBM Cloud Kubernetes Service region where you want to check the VLAN spanning status. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Details of VLAN spanning enablement.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanSpan" }, "example": { "enabled": true, "modifiedDate": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Unable to determine whether VLAN spanning is enabled in the IBM Cloud infrastructure account.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-ibm-events": { "description": "Details on whether the IBM Cloud account has VLAN spanning enabled are returned.", "events": [ { "name": "containers-kubernetes.account-subnet-vlan-spanning.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/subnets/vlan-spanning\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/user-config": { "get": { "description": "View whether a user can create free and paid clusters in a region and resource group. If `\"freeEnabled\": true` is returned, you can create a free cluster in the specified region. If `\"storedIaasCredentials\": true` is returned, your IBM Cloud account uses IBM Cloud infrastructure (SoftLayer) credentials that were manually set with the `POST ​/v1​/credentials` API or the `ibmcloud ks credential set` command. When you create a standard cluster in the specified region and resource group, these credentials are used.", "tags": [ "user" ], "summary": "View a user's ability to create free and standard clusters in a region and re...", "operationId": "GetUserConfig", "parameters": [ { "description": "Target the IBM Cloud Kubernetes Service region where you want to check the ability to create free and standard clusters. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The user's permissions to create free and paid clusters is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" }, "example": { "freeEnabled": true, "storedIaasCredentials": false } } } } }, "x-ibm-events": { "description": "Details on whether a user can create free or standard clusters in a certain region and resource group are returned.", "events": [ { "name": "containers-kubernetes.account-user-config.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/user-config\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/versions": { "get": { "description": "List available IBM Cloud Kubernetes Service versions that you can use to create a cluster in a region. The container management platform version that you select is installed on your cluster master and worker nodes. Later, you can update the version but cannot roll back to a previous version or switch to a different container management platform. If you want to use multiple versions, create a separate cluster for each version.", "tags": [ "util" ], "summary": "List available IBM Cloud Kubernetes Service versions.", "operationId": "GetVersions", "responses": { "200": { "description": "Success. Available container management platform versions for the IBM Cloud Kubernetes Service region are returned.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseVersion" }, "minItems": 0, "maxItems": 100 } }, "example": {} } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/versions\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v1/zones": { "get": { "description": "List available zones (data centers) where you can create a cluster.", "tags": [ "util" ], "summary": "List available zones (data centers).", "operationId": "GetZones", "parameters": [ { "description": "Specify true or false to show the machine types available in each zone.", "name": "show_flavors", "in": "query", "schema": { "type": "string" } }, { "description": "Specify a location to filter zones for. To see supported locations, use the `GET /v1​/locations` API or run `ibmcloud ks locations`.", "name": "location", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of available zones is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZonesV1" }, "example": [ { "flavors": [ { "cores": "example-value", "correspondingMachineType": "example-value", "deprecated": false, "gpus": "example-value", "isTrusted": false, "memory": "example-value", "name": "my-cluster", "networkSpeed": "example-value" } ], "id": "example-id-123", "metro": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v1/zones\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/addIgnoredIngressStatusErrors": { "post": { "description": "Ignore specific ingress status errors in ingress status reporting. Ignored errors will not affect the cluster's ingress status state.", "tags": [ "ingress-alb-beta" ], "summary": "Ignore specific ingress status errors in ingress status reporting.", "operationId": "AddIgnoredIngressStatusErrors", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/IgnoredIngressStatusErrors" }, "x-codegen-request-body-name": "ignoredIngressStatusErrors", "responses": { "200": { "description": "Ignored ingress status errors were successfully added to the ingress status configuration.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/alb/addIgnoredIngressStatusErrors\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/alb/getAlb": { "get": { "description": "View detailed information for an ALB in a VPC or classic cluster. An `ALBConfig` response will be returned for ALBs in classic clusters.", "tags": [ "ingress-alb-beta" ], "summary": "View details of an ALB.", "operationId": "V2GetClusterALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. This parameter is required for any resource group other than the default. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the ALB that you want details for. To list the IDs for the ALBs in a cluster, use the `GET /v2/alb/getClusterAlbs` API or run `ibmcloud ks alb ls --cluster `.", "name": "alb_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Details for the specified ALB are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALBConfig" }, "example": { "albBuild": "example-value", "albID": "example-id-123", "albType": "example-value", "authBuild": "example-value", "cluster": "example-value", "createdDate": "example-value", "disableDeployment": false, "enable": true } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or ALB could not be found. To list the classic clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/alb/getAlb?alb_id=example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/getAlbImages": { "get": { "description": "List the community Kubernetes Ingress controller and IBM Cloud Kubernetes Service ALB images that are supported.", "tags": [ "ingress-alb-beta" ], "summary": "List supported Ingress controller images.", "operationId": "GetSupportedImages", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of supported Ingress controller images is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minItems": 0, "maxItems": 100 }, "example": [ "example-value" ] } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to list supported Ingress controller images.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/alb/getAlbImages\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/getClusterAlbs": { "get": { "description": "List all ALBs in a VPC or classic cluster. A `ClusterALB` response will be returned for classic clusters.\n\nNote: If no ALB IDs are returned for a VPC cluster, no VPC load balancer exists for the ALBs. If no ALB IDs are returned for a classic cluster, no available portable subnet exists in the VLANs that your ALBs are on.", "tags": [ "ingress-alb-beta" ], "summary": "List all ALBs in a cluster.", "operationId": "V2GetClusterALBs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "To list the classic clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of ALBs for the cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterALB" }, "example": { "alb": [ { "albBuild": "example-value", "albID": "example-id-123", "albType": "example-value", "authBuild": "example-value", "cluster": "example-value", "createdDate": "example-value", "disableDeployment": false, "enable": true } ], "dataCenter": "example-value", "id": "example-id-123", "ingressHostname": "my-cluster", "ingressSecretName": "my-cluster", "isPaid": false, "region": "us-south" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the classic clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/alb/getClusterAlbs?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/getIngressClusterHealthcheck": { "get": { "description": "Check the status of the in-cluster ALB health checker.", "tags": [ "ingress-alb-beta" ], "summary": "Get the status of the in-cluster ALB health checker.", "operationId": "GetIngressClusterHealthcheck", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The in-cluster ALB health checker status for your cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALBClusterHealthCheckConfig" }, "example": { "cluster": "example-value", "enable": true } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/alb/getIngressClusterHealthcheck?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/getStatus": { "get": { "description": "Check the status of the IBM provided subdomain and application load balancers", "tags": [ "ingress-alb-beta" ], "summary": "Get the status of the ingress resources in a cluster.", "operationId": "GetStatus", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want information about.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The ingress status for your cluster is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" }, "example": { "StatusList": [ { "component": "example-value", "status": "example-value", "type": "example-value" } ], "albStatus": [ { "component": "example-value", "status": [ "example-value" ] } ], "cluster": "example-value", "enabled": true, "generalComponentStatus": [ { "component": "example-value", "status": [ "example-value" ] } ], "ignoredErrors": [ "example-value" ], "message": "example-value", "nonTranslatedStatus": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/alb/getStatus?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/listIgnoredIngressStatusErrors": { "get": { "description": "List all ingress status errors that are ignored for the cluster. If no ignored errors are returned, then the cluster does not have ignored ingress status errors.", "tags": [ "ingress-alb-beta" ], "summary": "List all ingress status errors that are ignored for the cluster.", "operationId": "ListIgnoredIngressStatusErrors", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. All ignored ingress status errors for your cluster are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnoredIngressStatusErrors" }, "example": { "cluster": "example-value", "ignoredErrors": [ "example-value" ] } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/alb/listIgnoredIngressStatusErrors?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/removeIgnoredIngressStatusErrors": { "delete": { "description": "Unignore specific ingress status errors in ingress status reporting. Unignored errors will affect the cluster's ingress status state.", "tags": [ "ingress-alb-beta" ], "summary": "Unignore specific ingress status errors in ingress status reporting.", "operationId": "RemoveIgnoredIngressStatusErrors", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/IgnoredIngressStatusErrors" }, "x-codegen-request-body-name": "ignoredIngressStatusErrors", "responses": { "200": { "description": "Ignored ingress status errors were successfully removed from the ingress status configuration.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v2/alb/removeIgnoredIngressStatusErrors\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/alb/setIngressClusterHealthcheck": { "post": { "description": "Set the in-cluster ingress health checker state. It can be either enabled or disabled.", "tags": [ "ingress-alb-beta" ], "summary": "Set the in-cluster ingress health checker.", "operationId": "SetIngressClusterHealthcheck", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALBClusterHealthCheckConfig" } } }, "description": "The desired state of the in-cluster ingress health checker.", "required": true }, "x-codegen-request-body-name": "albClusterHealthCheckConfig", "responses": { "200": { "description": "Set successfully finished.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/alb/setIngressClusterHealthcheck\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"enable\": true\n", "}'\n" ] } ] } ] } } } }, "/v2/alb/setIngressStatusState": { "post": { "description": "Set the state of the ingress status for a cluster. It can be either enabled or disabled.", "tags": [ "ingress-alb-beta" ], "summary": "Set the state of the ingress status.", "operationId": "SetIngressStatusState", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusState" } } }, "description": "The desired state of ingress status.", "required": true }, "x-codegen-request-body-name": "statusState", "responses": { "200": { "description": "Set successfully finished.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/alb/setIngressStatusState\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"enable\": true\n", "}'\n" ] } ] } ] } } } }, "/v2/alb/updateAlb": { "post": { "description": "Update one or more public or private ALBs to a supported IBM Cloud Kubernetes Service ALB image or a supported community Kubernetes Ingress controller image. To update your ALB to a specified image version, automatic updates must be disabled. You can check the automatic update status by using the `GET ​/v1​/alb​/clusters​/{idOrName}​/updatepolicy` call. NOTE: You cannot use this call to switch your ALB from one type of image to another, such as from an IBM Cloud Kubernetes Service ALB image to a community Kubernetes Ingress controller image. Instead, first disable the ALB by using the `DELETE ​/v1​/alb​/albs​/{albID}` call (classic) or the `POST /v2​/alb​/vpc​/disableAlb` call (VPC). Then, enable the ALB by using the `POST ​/v1​/alb​/albs` (classic) or `POST ​/v2​/alb​/vpc​/enableAlb` (VPC) call, and include the ALB image that you want to switch to in the input parameter.", "tags": [ "ingress-alb-beta" ], "summary": "Update ALBs in a cluster.", "operationId": "V2UpdateALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2UpdateALB" } } }, "description": "The input parameter to update an ALB's image. To see the supported image versions, use the `GET ​/v2​/alb​/getAlbImages` call.", "required": true }, "x-codegen-request-body-name": "albConfig", "responses": { "200": { "description": "Updated. The ALBs in the cluster were successfully updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster or ALB could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/alb/updateAlb\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"albBuild\": \"example-value\",\n", " \"albList\": [\n", " \"example-value\"\n", " ],\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/alb/vpc/createAlb": { "post": { "description": "Create a new public or private ALB in a specified zone and VPC cluster.", "tags": [ "ingress-alb-beta" ], "summary": "Create a public or private ALB in a specified zone and VPC cluster.", "operationId": "VpcCreateALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALB" } } }, "description": "The input parameters to create an ALB. For more information, see https://ibm.biz/alb_create_vpc", "required": true }, "x-codegen-request-body-name": "alb", "responses": { "201": { "description": "The ALB was successfully created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlbCreateResp" }, "example": { "alb": "example-value", "cluster": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster or zone could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`. To list the zones available in a VPC cluster, use the `GET /v2/vpc/getCluster` API or run `ibmcloud ks cluster-get --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/alb/vpc/createAlb\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"enableByDefault\": true,\n", " \"ingressImage\": \"example-value\",\n", " \"type\": \"example-value\",\n", " \"zone\": \"us-south-1\"\n", "}'\n" ] } ] } ] } } } }, "/v2/alb/vpc/disableAlb": { "post": { "description": "Disable a public or private ALB in your VPC cluster.", "tags": [ "ingress-alb-beta" ], "summary": "Disable an ALB in your VPC cluster.", "operationId": "VpcDisableALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALBConfig" } } }, "description": "The input parameters to disable an ALB. DisableDeployment and albID are required. For more information, see https://ibm.biz/alb_configure_vpc", "required": true }, "x-codegen-request-body-name": "alb-config", "responses": { "204": { "description": "Disabled. The ALB for the cluster was successfully disabled.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or ALB could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`. To list the ALBs in a cluster, use the `GET /v2/alb/getClusterAlbs` API or run `ibmcloud ks alb ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/alb/vpc/disableAlb\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"albBuild\": \"example-value\",\n", " \"albID\": \"example-id-123\",\n", " \"albType\": \"example-value\",\n", " \"authBuild\": \"example-value\",\n", " \"cluster\": \"example-value\",\n", " \"createdDate\": \"example-value\",\n", " \"disableDeployment\": false,\n", " \"enable\": true\n", "}'\n" ] } ] } ] } } } }, "/v2/alb/vpc/enableAlb": { "post": { "description": "Enable a public or private ALB in your VPC cluster.", "tags": [ "ingress-alb-beta" ], "summary": "Enable an existing ALB in a VPC cluster.", "operationId": "VpcEnableALB", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ALBConfig" } } }, "description": "The input parameter to enable an ALB. AlbID is required. To switch your ALB from one type of image to another, such as from an IBM Cloud Kubernetes Service ALB image to a community Kubernetes Ingress controller image, specify that image version in the ALBBuild field. To see the supported image versions, use the `GET ​/v2​/alb​/getAlbImages` call. For more information, see https://ibm.biz/alb_configure_vpc", "required": true }, "x-codegen-request-body-name": "albConfig", "responses": { "201": { "description": "Enabled. The ALB for the cluster was successfully enabled.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions to use a requested optional feature.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster or ALB could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`. To list the ALBs in a cluster, use the `GET /v2/alb/getClusterAlbs` API or run `ibmcloud ks alb ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/alb/vpc/enableAlb\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"albBuild\": \"example-value\",\n", " \"albID\": \"example-id-123\",\n", " \"albType\": \"example-value\",\n", " \"authBuild\": \"example-value\",\n", " \"cluster\": \"example-value\",\n", " \"createdDate\": \"example-value\",\n", " \"disableDeployment\": false,\n", " \"enable\": true\n", "}'\n" ] } ] } ] } } } }, "/v2/applyRBAC": { "post": { "description": "Apply IAM roles to the cluster. The roles are applied asynchronously. Use /v2/getRBACStatus to verify when they finish applying.", "tags": [ "v2" ], "summary": "Start applying IAM roles to the cluster.", "operationId": "ApplyRBAC", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) refresh token. To retrieve your IAM refresh token, run `cat ~/.bluemix/config.json`. To use the `POST https://iam.cloud.ibm.com/identity/token` API to create a token, see https://ibm.biz/iks-tokens for the required request headers.", "name": "X-Auth-Refresh-Token", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Kubeconfig" }, "x-codegen-request-body-name": "kubeconfigOptions", "responses": { "202": { "description": "Accepted. Applies IAM roles asynchronously.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "IAM roles are applied to the cluster, and the Kubernetes configuration file for the cluster is requested. Depending on the request, the kubeconfig might contain administrator or network certificates and secrets to access the cluster.", "events": [ { "name": "containers-kubernetes.cluster.config" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/applyRBAC\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/applyRBACAndGetKubeconfig": { "post": { "description": "Apply IAM roles to the cluster asynchronously, then retrieve the cluster's kubeconfig file to connect to your cluster and run Kubernetes API calls. Use `/v2/getRBACStatus` to verify when RBAC finishes applying.", "tags": [ "v2" ], "summary": "Apply IAM roles to the cluster asynchronously, then retrieve the cluster's ku...", "operationId": "ApplyRBACAndGetKubeconfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) refresh token. To retrieve your IAM refresh token, run `cat ~/.bluemix/config.json`. To use the `POST https://iam.cloud.ibm.com/identity/token` API to create a token, see https://ibm.biz/iks-tokens for the required request headers.", "name": "X-Auth-Refresh-Token", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Kubeconfig" }, "x-codegen-request-body-name": "kubeconfigOptions", "responses": { "200": { "description": "Ok. Returns the cluster's kubeconfig file.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientKubeConfig" }, "example": { "apiVersion": "1.28.5", "clusters": [ { "cluster": { "certificate-authority": "example-value", "certificate-authority-data": "example-value", "disable-compression": false, "insecure-skip-tls-verify": true, "proxy-url": "https://example.com", "server": "example-value", "tls-server-name": "my-cluster" }, "name": "my-cluster" } ], "contexts": [ { "context": { "cluster": "example-value", "namespace": "my-cluster", "user": "example-value" }, "name": "my-cluster" } ], "current-context": "example-value", "kind": "example-value", "preferences": { "colors": false }, "users": [ { "name": "my-cluster", "user": { "as": "example-value", "as-groups": [ "example-value" ], "as-uid": "example-id-123", "as-user-extra": {}, "auth-provider": { "config": {}, "name": "my-cluster" }, "client-certificate": "example-value", "client-certificate-data": "example-value", "client-key": "example-value" } } ] } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ClientKubeConfig" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ClientKubeConfig" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-ibm-events": { "description": "IAM roles are applied to the cluster, and the Kubernetes configuration file for the cluster is requested. Depending on the request, the kubeconfig might contain administrator or network certificates and secrets to access the cluster.", "events": [ { "name": "containers-kubernetes.cluster.config" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/applyRBACAndGetKubeconfig\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/autoUpdateMaster": { "post": { "description": "Set the autoupdate status of the cluster master. Only a limited set of users can access use this API.", "tags": [ "v2" ], "summary": "Set the autoupdate status of the cluster master.", "operationId": "autoUpdateMaster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoUpdateMaster" } } }, "description": "Input parameters to specify the name or ID of the cluster and whether to enable or disable auto master updates. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "required": true }, "x-codegen-request-body-name": "UpdateMaster", "responses": { "204": { "description": "Ok. The request was processed successfully.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The user doesn't have access to this API.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The specified value is already set on the cluster. To list the clusters properties, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The event that is generated depends on the operation that you request for the cluster.", "events": [ { "description": "Automatic updates for master fix pack patch updates are enabled. Generated if the `autoUpdate` parameter is set to `true`.", "name": "containers-kubernetes.cluster-master-autoupdate.enable" }, { "description": "Automatic updates for master fix pack patch updates are disabled. Generated if the `autoUpdate` parameter is set to `false`.", "name": "containers-kubernetes.cluster-master-autoupdate.disable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/autoUpdateMaster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"autoUpdate\": false,\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/classic/getCluster": { "get": { "description": "Detailed cluster information.", "tags": [ "v2" ], "summary": "Detailed cluster information.", "operationId": "classicGetCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to list clusters for. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, all the clusters in the account that you have access to are listed.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "To view additional cluster resources like addons, VLANs, subnets, and storage, pass `true`.", "name": "show_resources", "in": "query", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Detailed cluster information.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClusterResponse" }, "example": { "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "createdDate": "example-value", "crn": "example-value", "datacenter": "example-value", "desiredTrustedProfileID": "example-id-123", "disableAutoUpdate": false } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Details for a cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getCluster?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/classic/getClusters": { "get": { "description": "List the classic clusters that you have access to.", "tags": [ "v2" ], "summary": "List the classic clusters that you have access to.", "operationId": "classicGetClusters", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to list clusters for. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, all the clusters in the account that you have access to are listed.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "Specify a location to filter clusters for. To see supported locations, use the `GET /v1/locations` API or run `ibmcloud ks locations`.", "name": "location", "in": "query", "schema": { "type": "string" } }, { "description": "To view additional cluster resources like addons, VLANs, subnets, and storage, pass `true`.", "name": "show_resources", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of clusters that you have access to is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetClustersResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "createdDate": "example-value", "datacenter": "example-value", "desiredTrustedProfileID": "example-id-123", "entitlement": "example-value", "etcdPort": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Clusters are listed.", "events": [ { "name": "containers-kubernetes.cluster.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getClusters\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/classic/getPrivateServiceEnabled": { "get": { "description": "Get if VRF and Service Endpoint is enabled for the given account in the selected region.", "tags": [ "v2" ], "summary": "Get if VRF and Service Endpoint is enabled for the given account in the selec...", "operationId": "classicGetPrivateServiceEnabled", "parameters": [ { "description": "Specify the region to check for private service enablement.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the private service enablement.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateServiceEndpointEnabled" }, "example": { "isPrivateServiceEnabled": true } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Not authorized to use this command. Only a limited group of early adopters have access to this feature. If you are sure that you are part of the limited group of early adopters, contact IBM Cloud support..", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a worker pool in the cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getPrivateServiceEnabled\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/classic/getVLANs": { "get": { "description": "List available public and private VLANs for a specified zone (data center). Before using this operation, you must store your IBM Cloud classic infrastructure credentials in each Kubernetes Service account by using the `POST /v1/credentials` API or by running `ibmcloud ks credential set --infrastructure-api-key --infrastructure-username `.", "tags": [ "v2" ], "summary": "List available classic infrastructure VLANs for a zone.", "operationId": "getVLANs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to target.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the zone where you want to list available public and private VLANs. To list available zones, run `ibmcloud ks zone ls` or use the `GET /v1/datacenters` API.", "name": "zone", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of all VLANs is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VLANS" }, "example": [ { "id": "example-id-123", "properties": { "local_disk_storage_capability": "example-value", "location": "us-south", "name": "my-cluster", "note": "example-value", "primary_router": "example-value", "san_storage_capability": "example-value", "subnet_count": 3, "vlan_number": "example-value" }, "type": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "VLANs in an IBM Cloud account for a particular data center are listed.", "events": [ { "name": "containers-kubernetes.account-datacenter-vlan.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getVLANs?zone=us-south-1\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/classic/getWorker": { "get": { "description": "View detailed information for a worker node in a classic cluster.", "tags": [ "v2" ], "summary": "View details of a worker node for classic cluster.", "operationId": "classicGetWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node that you want details for. To list all worker nodes for a cluster, use the `GET /v1/clusters/{idOrName}/workers` API or run `ibmcloud ks workers `.", "name": "worker", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker node is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClassicWorkerResponse" }, "example": { "dedicatedHostId": "example-id-123", "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "health": { "message": "example-value", "state": "example-value" }, "id": "example-id-123", "kubeVersion": { "actual": "example-value", "desired": "example-value", "eos": "example-value", "masterEOS": "example-value", "target": "example-value" }, "lifecycle": { "actualOperatingSystem": "example-value", "actualState": "example-value", "desiredOperatingSystem": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "location": "us-south" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks clusters`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a worker node in the cluster are returned.", "events": [ { "name": "containers-kubernetes.worker.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getWorker?cluster=example-value&worker=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/classic/getWorkerPool": { "get": { "description": "View detailed information for a worker pool in a classic cluster.", "tags": [ "v2" ], "summary": "View details of a worker pool for a classic cluster.", "operationId": "classicGetWorkerPool", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool that you want details for. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "workerpool", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker pool is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClassicWorkerPoolResponse" }, "example": { "autoscaleEnabled": true, "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "flavorState": "example-value", "hostLabels": {}, "id": "example-id-123", "isBalanced": false, "isolation": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker pools for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getWorkerPool?cluster=example-value&workerpool=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/classic/getWorkerPools": { "get": { "description": "View detailed information for a worker pool in a classic cluster.", "tags": [ "v2" ], "summary": "View details of a worker pool for a classic cluster.", "operationId": "classicGetWorkerPools", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker pools is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetClassicWorkerPoolResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "autoscaleEnabled": true, "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "flavorState": "example-value", "hostLabels": {}, "id": "example-id-123", "isBalanced": false, "isolation": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a worker pool in the cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getWorkerPools?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/classic/getWorkers": { "get": { "description": "View detailed information for all worker nodes in a classic cluster.", "tags": [ "v2" ], "summary": "View all workers for a classic cluster.", "operationId": "classicGetWorkers", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks clusters`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "true|false Shows deleted workers", "name": "show_deleted", "in": "query", "schema": { "type": "string" } }, { "description": "The name or ID of the worker pool to filter results for. Run `ibmcloud ks worker-pool ls --cluster `.", "name": "pool", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Details for all workers in the classic cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClassicWorkersResponse" }, "example": [ { "dedicatedHostId": "example-id-123", "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "health": { "message": "example-value", "state": "example-value" }, "id": "example-id-123", "kubeVersion": { "actual": "example-value", "desired": "example-value", "eos": "example-value", "masterEOS": "example-value", "target": "example-value" }, "lifecycle": { "actualOperatingSystem": "example-value", "actualState": "example-value", "desiredOperatingSystem": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "location": "us-south" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks clusters`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker nodes for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/classic/getWorkers?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/cluster-health/getIssue": { "get": { "description": "Use the `issue` query parameter with an issue code (for example `NHC002` or an Ingress-derived code). Requires the same IAM **Viewer** access on the cluster as `GET /v2/cluster-health/getIssues`.", "tags": [ "cluster-health" ], "summary": "Get detailed information for one health issue.", "operationId": "getClusterHealthIssue", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "Cluster ID or name.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Issue code (for example NHC002 or an Ingress error identifier).", "name": "issue", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Detailed health issue payload.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetailedHealthIssue" }, "example": { "component": "example-value", "description": "example-value", "detected": "example-value", "id": "example-id-123", "more_details": [ { "affected_component_type": "example-value", "affected_components": [ "example-value" ], "message": "example-value", "type": 1 } ], "severity": "example-value", "solution": "example-value" } } } }, "400": { "description": "Bad request. Missing or invalid `cluster` or `issue` query parameters.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The issue code is unknown or no longer reported for this cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "410": { "description": "Gone.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/cluster-health/getIssue?cluster=example-value&issue=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/cluster-health/getIssues": { "get": { "description": "Requires IAM **Viewer** on the cluster and a valid IBM Cloud IAM token. The cluster is identified by the required `cluster` query parameter (used for IAM resource binding).", "tags": [ "cluster-health" ], "summary": "List aggregated health issues for a cluster.", "operationId": "listClusterHealthIssues", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster get --cluster `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "Cluster ID or name (lowercased in the health service handler). Required for authorization middleware.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. An array of health issue summaries from all configured sources.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HealthIssueListItem" }, "minItems": 0, "maxItems": 100 }, "example": [ { "component": "example-value", "description": "example-value", "detected": "example-value", "id": "example-id-123", "severity": "example-value" } ] } } }, "400": { "description": "Bad request. The `cluster` query parameter is missing or invalid.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The caller lacks IAM View on the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "Gone. Cached health data is no longer available.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service or an upstream health source is unavailable. Wait a few minutes and try again. If the problem persists, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/cluster-health/getIssues?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/createDedicatedHost": { "post": { "description": "Create a dedicated host.", "tags": [ "v2" ], "summary": "Create a dedicated host.", "operationId": "createDedicatedHost", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDedicatedHost" } } }, "description": "The required dedicated host parameters.", "required": true }, "x-codegen-request-body-name": "dedicatedHostConfig", "responses": { "201": { "description": "Created. The dedicated host was successfully created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDedicatedHostResponse" }, "example": { "id": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "409": { "description": "Conflict. A dedicated host create may already be in progress. Please wait a few minutes and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A dedicated host is created.", "events": [ { "name": "containers-kubernetes.account-dedicated-host.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account-dedicated-host.create" } ], "description": "To create a dedicated host, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/createDedicatedHost\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"flavor\": \"example-value\",\n", " \"hostPoolID\": \"example-id-123\",\n", " \"zone\": \"us-south-1\"\n", "}'\n" ] } ] } ] } } } }, "/v2/createDedicatedHostPool": { "post": { "description": "Create a dedicated host pool.", "tags": [ "v2" ], "summary": "Create a dedicated host pool.", "operationId": "createDedicatedHostPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to create the dedicated host pool in. To list available resource groups, run `ibmcloud resource groups`. If this header is not included, the dedicated host pool is created in the default resource group.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDedicatedHostPool" } } }, "description": "The required dedicated host pool parameters.", "required": true }, "x-codegen-request-body-name": "dedicatedHostPoolConfig", "responses": { "201": { "description": "Created. The dedicated host pool was successfully created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDedicatedHostResponse" }, "example": { "id": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "409": { "description": "Conflict. Creation of a dedicated host might already be in progress. Please wait a few minutes and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A dedicated host is created.", "events": [ { "name": "containers-kubernetes.account-dedicated-host-pool.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account-dedicated-host-pool.create" } ], "description": "To create a dedicated host pool, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/createDedicatedHostPool\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"flavorClass\": \"example-value\",\n", " \"metro\": \"example-value\",\n", " \"name\": \"my-cluster\"\n", "}'\n" ] } ] } ] } } } }, "/v2/disableDedicatedHostPlacement": { "post": { "description": "Disable placement of worker nodes on a dedicated host.", "tags": [ "v2" ], "summary": "Disable dedicated host placement.", "operationId": "disableDedicatedHostPlacement", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDedicatedHost" } } }, "description": "The dedicated host pool and host to disable placement on.", "required": true }, "x-codegen-request-body-name": "dedicatedHostConfig", "responses": { "200": { "description": "OK. The dedicated host placement was successfully disabled.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Dedicated host placement is disabled.", "events": [ { "name": "containers-kubernetes.account-dedicated-host-placement.disable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account-dedicated-host-placement.disable" } ], "description": "To disable dedicated host placement, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/disableDedicatedHostPlacement\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"hostID\": \"example-id-123\",\n", " \"hostPoolID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v2/disableImageSecurity": { "post": { "description": "Disable image security enforcement for a cluster", "tags": [ "image-security" ], "operationId": "V2DisableImageSecurity", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageSecurity" } } }, "description": "Input parameters to specify the name or ID of the cluster that you want to disable image security enforcement in.", "required": true }, "x-codegen-request-body-name": "DisableImageSecurity", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/disableImageSecurity\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/disablePodSecurityPolicy": { "post": { "description": "Deprecated: This API was only available for Kubernetes clusters that ran version 1.24. Disable the Pod Security Policy admission controller for Kubernetes. Use this API when migrating from the deprecated Pod Security Policy to the Pod Security admission controller.", "tags": [ "pod-security" ], "summary": "Deprecated: Disable the Pod Security Policy admission controller.", "operationId": "V2DisablePodSecurityPolicy", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisablePodSecurityPolicyRequest" } } }, "description": "The cluster to target.", "required": true }, "x-codegen-request-body-name": "disableRequest", "responses": { "204": { "description": "OK. The request to disable the Pod Security Policy admission controller was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. \\\nBad Request. Your cluster must run Kubernetes version 1.24 to change the Pod Security Policy admission controller. \\\nBad Request. Cannot disable the Pod Security Policy admission controller when the Pod Security admission controller is disabled.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } } }, "x-ibm-events": { "description": "The Pod Security Policy admission controller is disabled.", "events": [ { "name": "containers-kubernetes.cluster-pod-security.disable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To change the Pod Security Policy admission controller configuration, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/disablePodSecurityPolicy\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/disablePrivateServiceEndpoint": { "post": { "tags": [ "beta" ], "summary": "Disables a private service endpoint for a cluster.", "operationId": "v2DisablePrivateServiceEndpoint", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/UpdateServiceEndpoint" }, "x-codegen-request-body-name": "UpdateServiceEndpoint", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The cluster cannot be updated. The master is more than two versions behind the targeted version, which is not supported. Instead, update to a supported version two or less ahead of the current version, or create a new cluster at the targeted version.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The private service endpoint for a cluster is disabled.", "events": [ { "name": "containers-kubernetes.cluster-private-service-endpoint.disable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/disablePrivateServiceEndpoint\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/disablePublicServiceEndpoint": { "post": { "tags": [ "beta" ], "summary": "Disables a public service endpoint for a cluster.", "operationId": "v2DisablePublicServiceEndpoint", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/UpdateServiceEndpoint" }, "x-codegen-request-body-name": "UpdateServiceEndpoint", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The cluster cannot be updated. The master is more than two versions behind the targeted version, which is not supported. Instead, update to a supported version two or less ahead of the current version, or create a new cluster at the targeted version.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The public service endpoint for a cluster is disabled.", "events": [ { "name": "containers-kubernetes.cluster-public-service-endpoint.disable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/disablePublicServiceEndpoint\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/enableDedicatedHostPlacement": { "post": { "description": "Enable placement of worker nodes on a dedicated host.", "tags": [ "v2" ], "summary": "Enable dedicated host placement.", "operationId": "enableDedicatedHostPlacement", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDedicatedHost" } } }, "description": "The dedicated host pool and host to enable placement on.", "required": true }, "x-codegen-request-body-name": "dedicatedHostConfig", "responses": { "200": { "description": "OK. The dedicated host placement was successfully enabled.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Dedicated host placement is enabled.", "events": [ { "name": "containers-kubernetes.account-dedicated-host-placement.enable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account-dedicated-host-placement.enable" } ], "description": "To enable dedicated host placement, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/enableDedicatedHostPlacement\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"hostID\": \"example-id-123\",\n", " \"hostPoolID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v2/enableImageSecurity": { "post": { "description": "Enable image security enforcement for a cluster", "tags": [ "image-security" ], "operationId": "V2EnableImageSecurity", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageSecurity" } } }, "description": "Input parameters to specify the name or ID of the cluster that you want to enable image security enforcement in.", "required": true }, "x-codegen-request-body-name": "EnableImageSecurity", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/enableImageSecurity\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/enableKMS": { "post": { "description": "Enables a key management service (KMS) provider, such as IBM Key Protect, in a cluster. You cannot later disable KMS encryption, so make sure not to delete the KMS instance that you use to encrypt the cluster.", "tags": [ "v2" ], "summary": "Enables KMS in a cluster", "operationId": "kmsEnableCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableKMSRequest" } } }, "description": "Input parameters to create the Key Protect config for your cluster.", "required": true }, "x-codegen-request-body-name": "keyProtectConfig", "responses": { "200": { "description": "Ok. The requested KMS configuration has been enabled on the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or worker could not be found. To list the clusters that you have access to, use the `GET /vpc/v2/clusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A key management service (KMS) provider is enabled for a cluster.", "events": [ { "name": "containers-kubernetes.cluster-kms.enable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/enableKMS\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"account_id\": \"example-id-123\",\n", " \"cluster\": \"example-value\",\n", " \"crk_id\": \"example-id-123\",\n", " \"instance_id\": \"example-id-123\",\n", " \"private_endpoint\": false\n", "}'\n" ] } ] } ] } } } }, "/v2/enablePodSecurityPolicy": { "post": { "description": "Deprecated: This API was only available for Kubernetes clusters that ran version 1.24. Enable the Pod Security Policy admission controller. Use this API when migrating from the deprecated Pod Security Policy to the Pod Security admission controller.", "tags": [ "pod-security" ], "summary": "Deprecated: Enable the Pod Security Policy admission controller.", "operationId": "V2EnablePodSecurityPolicy", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnablePodSecurityPolicyRequest" } } }, "description": "The cluster to target.", "required": true }, "x-codegen-request-body-name": "enableRequest", "responses": { "204": { "description": "OK. The request to enable the Pod Security Policy admission controller was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. \\\nBad Request. Your cluster must run Kubernetes version 1.24 to change the Pod Security Policy admission controller.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } } }, "x-ibm-events": { "description": "The Pod Security Policy admission controller configuration is updated.", "events": [ { "name": "containers-kubernetes.cluster-pod-security-policy.enable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To change the Pod Security Policy admission controller configuration, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/enablePodSecurityPolicy\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/enablePrivateServiceEndpoint": { "post": { "tags": [ "beta" ], "summary": "Enables the private service endpoint for a cluster.", "operationId": "v2EnablePrivateServiceEndpoint", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/UpdateServiceEndpoint" }, "x-codegen-request-body-name": "UpdateServiceEndpoint", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The cluster cannot be updated. The master is more than two versions behind the targeted version, which is not supported. Instead, update to a supported version two or less ahead of the current version, or create a new cluster at the targeted version.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The private service endpoint for a cluster is enabled.", "events": [ { "name": "containers-kubernetes.cluster-private-service-endpoint.enable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/enablePrivateServiceEndpoint\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/enablePublicServiceEndpoint": { "post": { "tags": [ "beta" ], "summary": "Enables the public service endpoint for a cluster.", "operationId": "v2EnablePublicServiceEndpoint", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/UpdateServiceEndpoint" }, "x-codegen-request-body-name": "UpdateServiceEndpoint", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The cluster cannot be updated. The master is more than two versions behind the targeted version, which is not supported. Instead, update to a supported version two or less ahead of the current version, or create a new cluster at the targeted version.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The public service endpoint for a cluster is enabled.", "events": [ { "name": "containers-kubernetes.cluster-public-service-endpoint.enable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/enablePublicServiceEndpoint\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/enablePullSecret": { "post": { "tags": [ "beta" ], "summary": "Create an image pull secret to IBM Cloud Container Registry in the `default` ...", "operationId": "v2EnablePullSecret", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnablePullSecret" } } }, "description": "Input parameters to specify the name or ID of the cluster and which to enable pull secrets for.", "required": true }, "x-codegen-request-body-name": "EnablePullSecret", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An image pull secret is created in the default namespace of the cluster.", "events": [ { "name": "containers-kubernetes.cluster-pull-secret.enable" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service and Administrator platform role to Container Registry in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/enablePullSecret\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/getCACert": { "get": { "description": "Get the cluster's CA cert to configure services with it to connect to the given cluster.", "tags": [ "v2" ], "summary": "Get the cluster's CA cert.", "operationId": "GetCACert", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get CA cert from. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Returns the cluster's CA cert.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The query parameters are either incomplete or in the wrong format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The CA cert for a cluster is requested.", "events": [ { "name": "containers-kubernetes.cluster-ca-certificate.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getCACert?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getCRKs": { "get": { "description": "List all the customer root keys (CRKs) for a Key Management Service (KMS) instance, such as a Key Protect service instance, in your IBM Cloud account.", "tags": [ "v2" ], "summary": "List the root keys for a Key Management Service instance.", "operationId": "kmsGetCRKs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The KMS instance ID to list root keys for. To list available Key Protect service instances, run `ibmcloud ks kms instance ls`.", "name": "kms_instance", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of available root keys in the KMS instance is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/GetCRKResponse" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or worker could not be found. To list the clusters that you have access to, use the `GET /vpc/v2/clusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Root keys from key management service instances for the IBM Cloud account are listed.", "events": [ { "name": "containers-kubernetes.account-customer-root-key.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getCRKs?kms_instance=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getCluster": { "get": { "description": "View detailed information for a cluster, including a VPC cluster.", "tags": [ "v2" ], "summary": "View details for a cluster.", "operationId": "getCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to list clusters for. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, all the clusters in the account that you have access to are listed.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Detailed cluster information is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClusterResponse" }, "example": { "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "createdDate": "example-value", "crn": "example-value", "datacenter": "example-value", "desiredTrustedProfileID": "example-id-123", "disableAutoUpdate": false } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Details for a cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getCluster?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getClusterAddons": { "get": { "description": "View details of the add-ons that are enabled in a cluster, including the add-on versions.", "tags": [ "v2" ], "summary": "View details of the add-ons that are enabled in a cluster.", "operationId": "v2GetClusterAddons", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group of the cluster, use the `GET /v1/clusters/{idOrName}` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Details for the add-ons in this cluster are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ClusterAddon" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Cluster add-ons are listed.", "events": [ { "name": "containers-kubernetes.cluster-addon.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getClusterAddons?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getDedicatedHost": { "get": { "description": "View detailed information for a dedicated host.", "tags": [ "v2" ], "summary": "View details of a dedicated host.", "operationId": "getDedicatedHost", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the dedicated host that you want details for..", "name": "dedicatedhost", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the dedicated host pool that you want to get the dedicated host details from.", "name": "dedicatedhostpool", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the dedicated host is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDedicatedHost" }, "example": { "flavor": "example-value", "id": "example-id-123", "lifecycle": { "actualState": "example-value", "createdDate": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "placementEnabled": true, "resources": { "capacity": { "memoryBytes": 1, "vcpu": 1 }, "consumed": { "memoryBytes": 1, "vcpu": 1 } }, "workers": [ { "clusterID": "example-id-123", "flavor": "example-value", "workerID": "example-id-123", "workerPoolID": "example-id-123" } ], "zone": "us-south-1" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified dedicated host could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a dedicated host are returned.", "events": [ { "name": "containers-kubernetes.account-dedicated-host.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account.read" } ], "description": "To view the details of a dedicated host, you must have the Viewer platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getDedicatedHost?dedicatedhost=example-value&dedicatedhostpool=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getDedicatedHostPool": { "get": { "description": "View detailed information for a dedicated host pool.", "tags": [ "v2" ], "summary": "View details of a dedicated host pool.", "operationId": "getDedicatedHostPool", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the dedicated host pool that you want to get.", "name": "dedicatedhostpool", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the dedicated host pool is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDedicatedHostPool" }, "example": { "flavorClass": "example-value", "hostCount": 3, "id": "example-id-123", "metro": "example-value", "name": "my-cluster", "state": "example-value", "workerPools": [ { "clusterID": "example-id-123", "workerPoolID": "example-id-123" } ], "zones": [ { "capacity": { "memoryBytes": 1, "vcpu": 1 }, "hostCount": 3, "zone": "us-south-1" } ] } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified dedicated host could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. The IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a dedicated host pool are returned.", "events": [ { "name": "containers-kubernetes.account-dedicated-host-pool.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account.read" } ], "description": "To view the details of a dedicated host pool, the user must have the Viewer platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getDedicatedHostPool?dedicatedhostpool=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getDedicatedHostPools": { "get": { "tags": [ "v2" ], "summary": "List the dedicated host pools.", "operationId": "getDedicatedHostPools", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the dedicated host pools is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDedicatedHostPools" }, "example": [ { "flavorClass": "example-value", "hostCount": 3, "id": "example-id-123", "metro": "example-value", "name": "my-cluster", "state": "example-value", "workerPools": [ { "clusterID": "example-id-123", "workerPoolID": "example-id-123" } ], "zones": [ { "capacity": { "memoryBytes": 1, "vcpu": 1 }, "hostCount": 3, "zone": "us-south-1" } ] } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified dedicated host pool could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. The IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The dedicated host pools are listed.", "events": [ { "name": "containers-kubernetes.account-dedicated-host-pool.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account.read" } ], "description": "To list dedicated host pools, you must have the Viewer platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getDedicatedHostPools\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getDedicatedHosts": { "get": { "tags": [ "v2" ], "summary": "List the dedicated hosts.", "operationId": "getDedicatedHosts", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the dedicated host pool that you want to get the dedicated hosts details from.", "name": "dedicatedhostpool", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the dedicated hosts is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDedicatedHosts" }, "example": [ { "flavor": "example-value", "id": "example-id-123", "lifecycle": { "actualState": "example-value", "createdDate": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "placementEnabled": true, "resources": { "capacity": { "memoryBytes": 1, "vcpu": 1 }, "consumed": { "memoryBytes": 1, "vcpu": 1 } }, "workers": [ { "clusterID": "example-id-123", "flavor": "example-value", "workerID": "example-id-123", "workerPoolID": "example-id-123" } ], "zone": "us-south-1" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified dedicated host pool could not be found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The dedicated hosts are listed.", "events": [ { "name": "containers-kubernetes.account-dedicated-host.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account.read" } ], "description": "To list dedicated hosts, you must have the Viewer platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getDedicatedHosts?dedicatedhostpool=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getFlavor": { "get": { "description": "Get the details for a worker node flavor, including the flavor's virtual CPU amount, memory, disk space and supported operating systems. Flavors are specific to a IBM Cloud Kubernetes Service zone and infrastructure provider.", "tags": [ "v2" ], "summary": "Get the details for a worker node flavor", "operationId": "v2GetFlavor", "parameters": [ { "description": "The ID of the flavor. To list available flavors, run `ibmcloud ks flavors --zone ZONE` or use the `GET /v2/getFlavors` API.", "name": "flavor", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the zone. To list available zones, run `ibmcloud ks zone ls` or use the `GET /v2/zones` API.", "name": "zone", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name of the provider. To check available providers, see the output of the `ibmcloud ks flavors --zone ZONE` command or use the `GET /v2/getFlavors` API.", "name": "provider", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Flavor" }, "example": { "architecture": "example-value", "correspondingFlavor": "example-value", "deprecated": false, "id": "example-id-123", "isTrusted": false, "name": "my-cluster", "provider": "vpc-gen2", "secondaryStorage": "example-value" } } } }, "400": { "description": "The specified zone is invalid. To list available zones, run `ibmcloud ks zone ls` or use the `GET /v2/zones` API.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getFlavor?flavor=example-value&zone=us-south-1&provider=vpc-gen2\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getFlavors": { "get": { "description": "List available flavors that you can use for a worker node. Flavors are specific to a location and a provider in an IBM Cloud Kubernetes Service zone. Each flavor includes the amount of virtual CPU, memory, and disk space that is set up for the worker node.", "tags": [ "v2" ], "summary": "List available flavors types for a VPC zone (data center).", "operationId": "v2GetFlavors", "parameters": [ { "description": "The ID of the location for which you want to list available flavors. To list available locations, run `ibmcloud ks zone ls` or use the `GET /v2/zones` API.", "name": "zone", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Filters the flavors to match the provider type specified.", "name": "provider", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Flavor" }, "minItems": 0, "maxItems": 100 }, "example": [ { "architecture": "example-value", "correspondingFlavor": "example-value", "deprecated": false, "id": "example-id-123", "isTrusted": false, "name": "my-cluster", "provider": "vpc-gen2", "secondaryStorage": "example-value" } ] } } }, "400": { "description": "The specified location is invalid. To list available locations, run `ibmcloud ks zone ls` or use the `GET /v2/zones` API.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getFlavors?zone=us-south-1\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getKMSInstances": { "get": { "description": "Retrieves available key management service (KMS) instances, such as Key Protect, in your IBM Cloud Account", "tags": [ "v2" ], "summary": "Gets KMS instances tied to an account", "operationId": "kmsGetInstances", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of all KMSs in your IBM Cloud Account", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/GetKMSInstanceResponse" }, { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "minItems": 0, "maxItems": 100 }, "example": [] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or worker could not be found. To list the clusters that you have access to, use the `GET /vpc/v2/clusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Key management service instances in the IBM Cloud account are listed.", "events": [ { "name": "containers-kubernetes.account-key-management-service-instance.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getKMSInstances\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getKubeconfig": { "get": { "description": "Apply IAM roles to the cluster asynchronously and retrieve the cluster's kubeconfig file to connect to your cluster and run Kubernetes API calls. Use `/v2/getRBACStatus` to verify when RBAC finishes applying.", "tags": [ "v2" ], "summary": "Get the cluster's kubeconfig file.", "operationId": "GetKubeconfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) refresh token. To retrieve your IAM refresh token, run `cat ~/.bluemix/config.json`. To use the `POST https://iam.cloud.ibm.com/identity/token` API to create a token, see https://ibm.biz/iks-tokens for the required request headers.", "name": "X-Auth-Refresh-Token", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Default endpoint is the public endpoint if available, private otherwise. Use 'private' to require a private endpoint and 'link' for a Satellite Link endpoint.", "name": "endpoint_type", "in": "query", "schema": { "type": "string" } }, { "description": "Default format is json. Other options include yaml, and zip.", "name": "format", "in": "query", "schema": { "type": "string" } }, { "description": "Retrieve the admin kubeconfig file.", "name": "admin", "in": "query", "schema": { "type": "boolean" } }, { "description": "Retrieve the Calico network config. Requires admin=true and format=zip.", "name": "network", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok. Returns the cluster's kubeconfig file.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientKubeConfig" }, "example": { "apiVersion": "1.28.5", "clusters": [ { "cluster": { "certificate-authority": "example-value", "certificate-authority-data": "example-value", "disable-compression": false, "insecure-skip-tls-verify": true, "proxy-url": "https://example.com", "server": "example-value", "tls-server-name": "my-cluster" }, "name": "my-cluster" } ], "contexts": [ { "context": { "cluster": "example-value", "namespace": "my-cluster", "user": "example-value" }, "name": "my-cluster" } ], "current-context": "example-value", "kind": "example-value", "preferences": { "colors": false }, "users": [ { "name": "my-cluster", "user": { "as": "example-value", "as-groups": [ "example-value" ], "as-uid": "example-id-123", "as-user-extra": {}, "auth-provider": { "config": {}, "name": "my-cluster" }, "client-certificate": "example-value", "client-certificate-data": "example-value", "client-key": "example-value" } } ] } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ClientKubeConfig" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ClientKubeConfig" } } } }, "400": { "description": "Bad request. The query parameters are either incomplete or in the wrong format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } }, "application/zip": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "text/yaml": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-ibm-events": { "description": "The Kubernetes configuration file for a cluster is requested. Depending on the request, the kubeconfig might contain administrator or network certificates and secrets to access the cluster.", "events": [ { "name": "containers-kubernetes.cluster-config.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM. Note that to pull the networking or admin configuration files, you must have the Administrator platform role." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getKubeconfig?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getMessages": { "get": { "description": "View the current messages. Messages are notifications for new features or changes that may require attention.", "tags": [ "util" ], "summary": "View the current messages.", "operationId": "v2GetMessages", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`. If provided, additional messages specific to you or your account may be included.", "name": "Authorization", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "id": "example-id-123", "message": "example-value", "services": [ "example-value" ] } ] } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getMessages\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getOperatingSystems": { "get": { "description": "Lists supported operating systems for the given configuration.", "tags": [ "v2" ], "summary": "List supported operating systems.", "operationId": "getOperatingSystems", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name of the infrastructure provider in which to view supported operating systems. Available options include 'classic', 'vpc-gen2', and 'satellite'.", "name": "provider", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The Kubernetes or Openshift version.", "name": "version", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Whether HyperShift is enabled.", "name": "core_os_enabled", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Ok. The request to list supported operating systems was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OperatingSystem" }, "minItems": 0, "maxItems": 100 }, "example": [ { "isDefault": false, "isDeprecated": false, "name": "my-cluster", "workerPoolCreateUnsupported": false } ] } } }, "400": { "description": "Bad Request. Required parameters were not set. You must provide the `version` and `provider` query parameters.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } } }, "x-ibm-events": { "description": "Lists the supported operating systems for the given configuration.", "events": [ { "name": "cluster-worker-pool-supported-operating-systems.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getOperatingSystems?provider=vpc-gen2&version=1.28.5\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getPodSecurity": { "get": { "description": "View the Pod Security admission control configuration for a cluster.", "tags": [ "pod-security" ], "summary": "View the Pod Security admission control configuration for a cluster.", "operationId": "V2GetPodSecurity", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the Pod Security admission control configuration for. To list the clusters that you have access to, use the `GET /v2/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The request to view the Pod Security admission control configuration was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PodSecurityResponse" }, "example": { "configuration": "example-value", "enabled": true } } } }, "400": { "description": "Bad Request. Required parameters were not set. You must provide the `cluster` query parameter. \\\nBad Request. Pod Security admission is supported only for Kubernetes v1.24 or later clusters. \\\nBad Request. Pod Security admission is not supported for Red Hat OpenShift clusters.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } } }, "x-ibm-events": { "description": "View the Pod Security admission control configuration for a cluster.", "events": [ { "name": "containers-kubernetes.cluster-pod-security.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getPodSecurity?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getPodSecurityPolicy": { "get": { "description": "Deprecated: This API was only available for Kubernetes clusters that ran version 1.24. View the Pod Security Policy admission control configuration. Use this API when migrating from the deprecated Pod Security Policy to the Pod Security admission controller.", "tags": [ "pod-security" ], "summary": "Deprecated: View the Pod Security Policy admission control configuration.", "operationId": "V2GetPodSecurityPolicy", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the Pod Security admission control configuration for. To list the clusters that you have access to, use the `GET /v2/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The request to view Pod Security Policy admission control configuration was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PodSecurityPolicyResponse" }, "example": { "enabled": true } } } }, "400": { "description": "Bad Request. Required parameters were not set. You must provide the `cluster` query parameter. \\\nBad Request. Pod Security admission configuration is not supported for OpenShift clusters. \\\nBad Request. Your cluster must run Kubernetes version 1.24 to remove the Pod Security admission controller or to change the Pod Security Policy admission controller.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } } }, "x-ibm-events": { "description": "View the Pod Security Policy admission control configuration for a cluster that runs Kubernetes version 1.24.", "events": [ { "name": "containers-kubernetes.cluster-pod-security-policy.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getPodSecurityPolicy?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getQuota": { "get": { "description": "View the quota for IBM Cloud Kubernetes Service resources such as clusters and worker nodes. The quota is per region and applies across resource groups in the account. To increase your quota, contact IBM Support and include the new quota limit that you want for the region, resource, and infrastructure provider such as classic or VPC.", "tags": [ "v2" ], "summary": "View the quota for resources per region in the account.", "operationId": "GetQuota", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. A list of quota limits for resources per region in the account is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuota" }, "example": [ { "infrastructure": "example-value", "regions": [ { "id": "example-id-123", "quota": 1 } ], "type": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The quota for resources such as clusters or worker nodes for the IBM Cloud account is returned.", "events": [ { "name": "containers-kubernetes.account-quota.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getQuota\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getRBACStatus": { "get": { "description": "Get the RBACSync status for the authenticated user. The RBACSync status indicates whether the user has the correct identities and RoleBindings in the cluster. The `synchronized: true` status means the cluster is ready to receive requests from the user.\nAfter calling the `/v2/applyRBAC` endpoint for the first time on a cluster, poll this endpoint to verify the synchronization is complete.", "tags": [ "v2" ], "summary": "Get the RBACSync status.", "operationId": "GetRBACStatus", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the RBACSync status from. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "synchronized": { "type": "boolean" } } }, "example": { "synchronized": false } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The RBAC status of the user was requested.", "events": [ { "name": "containers-kubernetes.cluster-rbac.status" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the RBACSync status, you must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getRBACStatus?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getVersions": { "get": { "description": "List available versions that you can use to create a cluster in a region. The container management platform version that you select is installed on your cluster master and worker nodes. Later, you can update the version but cannot roll back to a previous version or switch to a different container management platform. If you want to use multiple versions, create a separate cluster for each version.", "tags": [ "beta" ], "summary": "List available cluster versions.", "operationId": "v2GetVersions", "responses": { "200": { "description": "Success. Available container management platform versions for the IBM Cloud Kubernetes Service region are returned.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseVersion" }, "minItems": 0, "maxItems": 100 } }, "example": {} } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getVersions\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getWorker": { "get": { "description": "View detailed information for a worker node in a cluster.", "tags": [ "v2" ], "summary": "View details of a worker node for cluster.", "operationId": "getWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster?cluster=idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node that you want details for. To list all worker nodes for a cluster, use the `GET /v2/getWorkers?cluster=idOrName` API or run `ibmcloud ks worker ls --cluster `.", "name": "worker", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker node is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCombinedWorkerResponse" }, "example": { "dedicatedHostId": "example-id-123", "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "health": { "message": "example-value", "state": "example-value" }, "id": "example-id-123", "kubeVersion": { "actual": "example-value", "desired": "example-value", "eos": "example-value", "masterEOS": "example-value", "target": "example-value" }, "lifecycle": { "actualOperatingSystem": "example-value", "actualState": "example-value", "desiredOperatingSystem": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "location": "us-south" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a worker node in the cluster are returned.", "events": [ { "name": "containers-kubernetes.worker.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getWorker?cluster=example-value&worker=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getWorkerPool": { "get": { "description": "View detailed information for a worker pool in a cluster.", "tags": [ "v2" ], "summary": "View details of a worker pool for a cluster.", "operationId": "getWorkerPool", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster?cluster=idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool that you want details for. To list all worker pools for a cluster, use the `GET /v2/getWorkerPools?cluster=idOrName` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "workerpool", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker pool is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCombinedWorkerPoolResponse" }, "example": { "autoscaleEnabled": true, "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "flavorState": "example-value", "hostLabels": {}, "id": "example-id-123", "isBalanced": false, "isolation": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a worker pool in the cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getWorkerPool?cluster=example-value&workerpool=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getWorkerPools": { "get": { "tags": [ "v2" ], "summary": "List the worker pools in a cluster.", "operationId": "getWorkerPools", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster?cluster=idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker pools is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetCombinedWorkerPoolResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "autoscaleEnabled": true, "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "flavorState": "example-value", "hostLabels": {}, "id": "example-id-123", "isBalanced": false, "isolation": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker pools for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getWorkerPools?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/getWorkers": { "get": { "description": "View detailed information for all worker nodes in a cluster.", "tags": [ "v2" ], "summary": "View all workers for cluster.", "operationId": "getWorkers", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster?cluster=idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "true|false Shows deleted workers", "name": "show_deleted", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Details for all workers in the cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkersResponse" }, "example": [ { "dedicatedHostId": "example-id-123", "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "health": { "message": "example-value", "state": "example-value" }, "id": "example-id-123", "kubeVersion": { "actual": "example-value", "desired": "example-value", "eos": "example-value", "masterEOS": "example-value", "target": "example-value" }, "lifecycle": { "actualOperatingSystem": "example-value", "actualState": "example-value", "desiredOperatingSystem": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "location": "us-south" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker nodes for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/getWorkers?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/hasValidEntitlement": { "get": { "description": "Validates whether the provided entitlement value is supported or not.", "tags": [ "v2" ], "summary": "Validates user provided entitlement.", "operationId": "hasValidEntitlement", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group whose API key token will be used for entitlement check. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, the cluster is created in the default resource group. After you create a cluster, you cannot change the resource group. Note that if you plan to integrate IBM Cloud services with the cluster, all the resources must be in the same group.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The entitlement value to check if it is supported.", "name": "entitlement", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. The entitlement validation request was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HasValidEntitlementResponse" }, "example": { "hasValidEntitlement": false } } } }, "400": { "description": "The entitlement option can not be set when the stored API key has a subtype. For more information, see 'http://ibm.biz/api-key'.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Could not connect to the back-end billing validation service. Try again later.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Validates whether the provided entitlement value is supported or not.", "events": [ { "name": "account-has-valid-entitlement.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/hasValidEntitlement?entitlement=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/nlb-dns/configureHealthMonitor": { "put": { "description": "Update the health monitoring configuration for the specified NLB subdomain in a cluster. Include the cluster ID, NLB subdomain, and any the provider specific configurations for the health check in the request body.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Update the health monitoring configuration for the specified NLB subdomain in...", "operationId": "ConfigureNLBDNSHealthMonitor", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthMonitorConfiguration" } } }, "description": "The full health monitoring configuration to overwrite the current configuration with. The configuration is defined in the corresponding provider specific field.", "required": true }, "x-codegen-request-body-name": "HealthMonitorConfiguration", "responses": { "204": { "description": "Ok. The request to update the health monitor config was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or NLB subdomain could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A health monitor config was updated.", "events": [ { "name": "cluster-nlb-dns-monitor.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To call this endpoint, you must have the Editor platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \"/global/v2/nlb-dns/configureHealthMonitor\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"akamaiMonitorConfiguration\": {\n", " \"httpError3xx\": false,\n", " \"httpError4xx\": false,\n", " \"httpError5xx\": false,\n", " \"httpHeaders\": [\n", " {\n", " \"name\": \"my-cluster\",\n", " \"value\": \"example-value\"\n", " }\n", " ],\n", " \"httpMethod\": \"example-value\",\n", " \"name\": \"my-cluster\",\n", " \"peerCertificateVerification\": false,\n", " \"testInterval\": 1\n", " },\n", " \"cluster\": \"example-value\",\n", " \"nlbSubdomain\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/nlb-dns/deleteSecret": { "post": { "description": "Delete a secret from an NLB subdomain in your cluster and prevent future renewal of the certificate. You might remove the secret from an NLB subdomain if you no longer use the subdomain or disassociate it from your NLB IP addresses.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Remove a secret from an NLB subdomain.", "operationId": "DeleteSecret", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretConfig" } } }, "description": "Include the NLB subdomain that you want to delete the secret for, and the cluster that the subdomain is in.", "required": true }, "x-codegen-request-body-name": "secretConfig", "responses": { "204": { "description": "Deleted. The secret name was successfully deleted for the NLB subdomain.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster, subdomain, or secret could not be found. To list clusters you have access to, run `ibmcloud ks cluster ls`. To list existing NLB subdomains and associated secret names, run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/nlb-dns/deleteSecret\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"subdomain\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/nlb-dns/getHealthMonitorConfig": { "get": { "description": "Get the health monitoring configuration for the specified NLB subdomain in a cluster.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Get the health monitoring configuration for the specified NLB subdomain in a ...", "operationId": "GetNLBDNSHealthMonitorConfiguration", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The existing NLB subdomain that you want the monitor config for. To list existing NLB subdomains, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "name": "nlb_subdomain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Current monitor config returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthMonitorConfiguration" }, "example": { "akamaiMonitorConfiguration": { "httpError3xx": false, "httpError4xx": false, "httpError5xx": false, "httpHeaders": [ { "name": "my-cluster", "value": "example-value" } ], "httpMethod": "example-value", "name": "my-cluster", "peerCertificateVerification": false, "testInterval": 1 }, "cluster": "example-value", "nlbSubdomain": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A health monitor config was returned.", "events": [ { "name": "cluster-nlb-dns-monitor.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To call this endpoint, you must have the Viewer platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/nlb-dns/getHealthMonitorConfig?cluster=example-value&nlb_subdomain=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/nlb-dns/getNlbDNSList": { "get": { "description": "List NLB subdomains and the NLB IP addresses or the load balancer hostnames that are registered with the DNS provider for each NLB subdomain.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "List registered NLB subdomains in a cluster.", "operationId": "GetNlbDNSList", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of NLB subdomains and associated details is returned for this cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2NlbList" }, "example": [ { "Nlb": { "certProvider": "vpc-gen2", "cluster": "example-value", "crn": "example-value", "dnsType": "example-value", "isDefault": false, "lbHostname": "my-cluster", "nlbIPArray": [ "example-value" ], "nlbSubdomain": "example-value" }, "secretName": "my-cluster", "secretStatus": "example-value" } ] } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/nlb-dns/getNlbDNSList?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/nlb-dns/getNlbDetails": { "get": { "description": "Get the details for the NLB subdomain and the NLB IP addresses or the load balancer hostnames that are registered with the DNS provider for each NLB subdomain.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Get the details for the specified NLB subdomain in a cluster.", "operationId": "GetNlbDNSDetails", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The existing NLB subdomain that you want details for. To list existing NLB subdomains, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "name": "nlb_subdomain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Details of the NLB subdomain are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbVPCListConfig" }, "example": { "Nlb": { "certProvider": "vpc-gen2", "cluster": "example-value", "crn": "example-value", "dnsType": "example-value", "isDefault": false, "lbHostname": "my-cluster", "nlbIPArray": [ "example-value" ], "nlbSubdomain": "example-value" }, "secretName": "my-cluster", "secretStatus": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/nlb-dns/getNlbDetails?cluster=example-value&nlb_subdomain=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/nlb-dns/getSatLocationSubdomain": { "get": { "description": "Get the details for the subdomain and the IP addresses that are registered with the DNS provider for each subdomain.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Get the details for the specified subdomain in a Satellite location.", "operationId": "GetSatLocationNlbDNSGet", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The existing subdomain that you want details for. To list existing subdomains, use the `GET /v2/nlb-dns/getSatLocationSubdomains` API or run `ibmcloud sat location dns ls --cluster `.", "name": "subdomain", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. A list of subdomains and associated details is returned for this location. If no list is returned, you can assign hosts to your location and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbConfig" }, "example": { "certProvider": "vpc-gen2", "clusterID": "example-id-123", "crn": "example-value", "isDefault": false, "nlbDnsType": "example-value", "nlbHost": "example-value", "nlbIPArray": [ "example-value" ], "nlbMonitorState": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your IAM and UAA tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite location. To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite 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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/nlb-dns/getSatLocationSubdomain?controller=example-value&subdomain=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/nlb-dns/getSatLocationSubdomains": { "get": { "description": "Get the details for the NLB subdomains along with the NLB IP addresses or CNAME records that are registered with the DNS provider for each NLB subdomain. Your Satellite location has a set of hosts that run control plane operations to manage your Satellite components across all the clusters in the location. If your location becomes unavailable, you might use the NLB subdomain and IP address details of the hosts to help troubleshoot.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "List registered NLB subdomains in a Satellite location.", "operationId": "GetSatLocationNlbDNSList", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. A list of NLB subdomains and associated details is returned for this location. If no list is returned, you can assign hosts to your location and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2NlbList" }, "example": [ { "Nlb": { "certProvider": "vpc-gen2", "cluster": "example-value", "crn": "example-value", "dnsType": "example-value", "isDefault": false, "lbHostname": "my-cluster", "nlbIPArray": [ "example-value" ], "nlbSubdomain": "example-value" }, "secretName": "my-cluster", "secretStatus": "example-value" } ] } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite location. To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite 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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/nlb-dns/getSatLocationSubdomains?controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/nlb-dns/regenerateCert": { "post": { "description": "Regenerate the certificate and recreate the secret for an NLB subdomain. You might regenerate an NLB subdomain's certificate and secret if you previously deleted the secret.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Regenerates cert for secret.", "operationId": "RegenerateCert", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretConfig" } } }, "description": "Include the cluster and subdomain for the NLB subdomain that you want to remove the secret from.", "required": true }, "x-codegen-request-body-name": "secretConfig", "responses": { "202": { "description": "The cert has been successfully triggered for regeneration.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster, subdomain, or secret could not be found. To list clusters you have access to, run `ibmcloud ks cluster ls`. To list existing NLB subdomains and relevant secret names, run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/nlb-dns/regenerateCert\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"subdomain\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/nlb-dns/registerMSCDomains": { "post": { "description": "Registers Multishift domains for a cluster.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Registers domains: c001, c002, c003, each tied to a corresponding IP and c000...", "operationId": "RegisterMultishiftCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MSCRegistration" } } }, "description": "The input parameter to register a Multishift cluster's domains.", "required": true }, "x-codegen-request-body-name": "mscRegistration", "responses": { "200": { "description": "Registered. The multishift cluster domains and cname have been successfully registered.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MSCRegisterResp" }, "example": { "controller": "example-value", "dnsRegistrations": [ { "ips": [ "example-value" ], "subdomain": "example-value" } ] } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or NLB subdomain could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. To list existing NLB subdomains for a cluster, use the `GET /clusters/{idOrName}/list` API or run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/nlb-dns/registerMSCDomains\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"controller\": \"example-value\",\n", " \"ips\": [\n", " \"example-value\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/v2/nlb-dns/vpc/createNlbDNS": { "post": { "description": "In a VPC cluster, create a new NLB subdomain and register a VPC load balancer hostname with the DNS provider. Note that you can create the NLB subdomain with only one VPC load balancer hostname. If the registration fails, an error from the DNS provider is returned.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Create a new NLB subdomain in a VPC cluster and associate a load balancer hos...", "operationId": "CreateNlbDNS", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbVPCConfig" } } }, "description": "Include the `lbHostname` parameter that specifies the VPC load balancer hostname that you want to register.", "required": true }, "x-codegen-request-body-name": "nlbVPCConfig", "responses": { "201": { "description": "Created. The NLB subdomain was successfully created and the VPC load balancer hostname is registered with DNS.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbVPCConfig" }, "example": { "cluster": "example-value", "dnsType": "example-value", "lbHostname": "my-cluster", "nlbSubdomain": "example-value", "secretNamespace": "my-cluster", "type": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified VPC cluster or load balancer hostname could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`. To list existing load balancer hostnames in a cluster, run `kubectl get svc -n `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. 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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/nlb-dns/vpc/createNlbDNS\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"dnsType\": \"example-value\",\n", " \"lbHostname\": \"my-cluster\",\n", " \"nlbSubdomain\": \"example-value\",\n", " \"secretNamespace\": \"my-cluster\",\n", " \"type\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/nlb-dns/vpc/removeLBHostname": { "post": { "description": "In a VPC cluster, remove a load balancer hostname from the DNS record for an existing NLB subdomain. After you remove the load balancer hostname, the NLB subdomain still exists, but no load balancer is associated with it.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Remove the load balancer hostname from the DNS record for an existing NLB sub...", "operationId": "RemoveLBHostname", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbVPCConfig" } } }, "description": "Include the cluster parameter (required) and the nlbSubdomain parameter (required) for the NLB subdomain that you want to remove the load balancer hostname from.", "required": true }, "x-codegen-request-body-name": "nlbVPCConfig", "responses": { "204": { "description": "Removed. The load balancer hostname was successfully unregistered from the DNS record for the NLB subdomain.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM or UAA token is invalid or expired. To retrieve your UAA and IAM tokens, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified VPC cluster or NLB subdomain could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`. To list existing NLB subdomains, run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/nlb-dns/vpc/removeLBHostname\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"dnsType\": \"example-value\",\n", " \"lbHostname\": \"my-cluster\",\n", " \"nlbSubdomain\": \"example-value\",\n", " \"secretNamespace\": \"my-cluster\",\n", " \"type\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/nlb-dns/vpc/replaceLBHostname": { "post": { "description": "In a VPC cluster, update the DNS record for an NLB subdomain by replacing the load balancer hostname that is currently associated with the NLB subdomain with another load balancer hostname. Only one load balancer hostname can be associated with an NLB DNS record at a time.", "tags": [ "ingress-nlb-dns-beta" ], "summary": "Update the DNS record for an NLB subdomain by replacing the load balancer hos...", "operationId": "ReplaceLBHostname", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbVPCConfig" } } }, "description": "Include only the `cluster` ID, existing `lbHostname` that you want to replace, and `nlbSubdomain` of the DNS record that you want to update.", "required": true }, "x-codegen-request-body-name": "nlbVPCConfig", "responses": { "200": { "description": "Ok. The request to update the load balancer hostname was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NlbVPCConfig" }, "example": { "cluster": "example-value", "dnsType": "example-value", "lbHostname": "my-cluster", "nlbSubdomain": "example-value", "secretNamespace": "my-cluster", "type": "example-value" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified VPC cluster, load balancer hostname, or NLB subdomain could not be found. To list the VPC clusters that you have access to, use the `GET /v2/vpc/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`. To list existing load balancer hostnames in a cluster, run `kubectl get svc -n `. To list existing NLB subdomains, run `ibmcloud ks nlb-dns ls --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. 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 the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/nlb-dns/vpc/replaceLBHostname\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"dnsType\": \"example-value\",\n", " \"lbHostname\": \"my-cluster\",\n", " \"nlbSubdomain\": \"example-value\",\n", " \"secretNamespace\": \"my-cluster\",\n", " \"type\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/rebalanceWorkerPool": { "post": { "description": "When you rebalance the worker pool, you return the number of worker nodes in the worker pool to a balanced state. For example, if you remove some worker nodes such as to troubleshoot an issue, you might have an uneven number of nodes across zones. You might delete 2 worker nodes in zone dal13 but still have 3 worker nodes each in zones dal10 and dal12 for a total of 7 worker nodes. To fix this unbalanced state, rebalance the worker pool. After rebalancing, the worker pool has 9 worker nodes again. Rebalancing does not change the size per zone of the worker pool, even if you specify a different size per zone.", "tags": [ "v2" ], "summary": "Rebalance workers in a worker pool.", "operationId": "rebalanceWorkerPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RebalanceWorkerPool" } } }, "description": "Fields required to rebalance the worker pool." }, "x-codegen-request-body-name": "rebalanceWorkerPoolRequest", "responses": { "204": { "description": "OK. The request to balance the worker pool was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is rebalanced.", "events": [ { "name": "containers-kubernetes.workerpool.rebalance" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/rebalanceWorkerPool\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"workerpool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/refreshMaster": { "post": { "description": "Restart the Kubernetes master in the cluster to apply changes to the API server configuration.", "tags": [ "v2" ], "summary": "Refresh the Kubernetes master.", "operationId": "vpcRefreshMaster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshMaster" } } }, "description": "Input parameters to refresh master. The cluster ID or name is required.", "required": true }, "x-codegen-request-body-name": "refreshMasterRequest", "responses": { "204": { "description": "Ok. The Master will be put into the desired state.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad Request. Check that all headers are present and the cluster ID or name is provided.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster. To list the clusters that you have access to, use the `GET /vpc/v2/clusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster master refresh is requested.", "events": [ { "name": "containers-kubernetes.cluster-master.refresh" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/refreshMaster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/removeDedicatedHost": { "post": { "description": "Removes a dedicated host.", "tags": [ "v2" ], "summary": "Removes a dedicated host.", "operationId": "removeDedicatedHost", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDedicatedHost" } } }, "description": "The dedicated host to target in a given dedicated host pool.", "required": true }, "x-codegen-request-body-name": "removeRequest", "responses": { "202": { "description": "OK. The request to remove your dedicated host was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. The IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is deleted.", "events": [ { "name": "containers-kubernetes.account-dedicated-host.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account-dedicated-host.delete" } ], "description": "To remove a dedicated host, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/removeDedicatedHost\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"host\": \"example-value\",\n", " \"hostPool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/removeDedicatedHostPool": { "post": { "description": "Removes a dedicated host pool.", "tags": [ "v2" ], "summary": "Removes a dedicated host pool.", "operationId": "removeDedicatedHostPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveDedicatedHostPool" } } }, "description": "The dedicated host pool to target.", "required": true }, "x-codegen-request-body-name": "removeRequest", "responses": { "202": { "description": "OK. The request to remove your dedicated host pool was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. The IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is deleted.", "events": [ { "name": "containers-kubernetes.account-dedicated-host-pool.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.account-dedicated-host-pool.delete" } ], "description": "To remove a dedicated host pool, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/removeDedicatedHostPool\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"hostPool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/removePodSecurity": { "post": { "description": "Deprecated: This API was only available for Kubernetes clusters that ran version 1.24. Remove the Pod Security admission controller configuration. Use this API when migrating from the deprecated Pod Security Policy to the Pod Security admission controller.", "tags": [ "pod-security" ], "summary": "Deprecated: Remove the Pod Security admission controller configuration for Ku...", "operationId": "V2RemovePodSecurity", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemovePodSecurityRequest" } } }, "description": "The cluster to target.", "required": true }, "x-codegen-request-body-name": "removeRequest", "responses": { "204": { "description": "OK. The request to remove the Pod Security admission controller configuration was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. \\\nBad Request. Your cluster must run Kubernetes version 1.24 to remove the Pod Security admission controller or to change the Pod Security Policy admission controller. \\\nBad Request. Cannot disable the Pod Security admission controller when the Pod Security Policy admission controller is disabled.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } } }, "x-ibm-events": { "description": "The Pod Security admission controller configuration is removed.", "events": [ { "name": "containers-kubernetes.cluster-pod-security.remove" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To change the Pod Security admission controller configuration, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/removePodSecurity\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/removeWorker": { "post": { "description": "Delete a worker node from a cluster. This action cannot be undone. When you delete the worker node, the worker node is cordoned and drained so that its pods are rescheduled onto remaining worker nodes in the cluster. Make sure that you have enough capacity in the cluster to support the workload. After you remove the worker node, you can rebalance the worker pool.", "tags": [ "v2" ], "summary": "Delete a worker node from a cluster.", "operationId": "v2RemoveWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveWorker" } } }, "description": "Input parameters to remove a worker node. The cluster and worker node ID parameters are required.", "required": true }, "x-codegen-request-body-name": "removeWorkerRequest", "responses": { "204": { "description": "Ok. The worker node was successfully removed from your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "The specified cluster or worker node could not be found. To list the clusters that you have access to, use the `GET /v2/clusters` API or run `ibmcloud ks cluster ls`. To list worker nodes in the cluster, use the `GET /v2/getWorkers` API or run `ibmcloud ks worker ls -c `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker node is deleted from the cluster.", "events": [ { "name": "containers-kubernetes.worker.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/removeWorker\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"workerID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v2/removeWorkerPool": { "post": { "description": "Remove a worker pool from a cluster. All worker nodes in the pool are deleted. Your pods are rescheduled when you delete. To avoid downtime, be sure that you have enough workers to run your workload.", "tags": [ "v2" ], "summary": "Removes a worker pool.", "operationId": "removeWorkerPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveWorkerPool" } } }, "description": "The cluster and worker pool to target.", "required": true }, "x-codegen-request-body-name": "removeRequest", "responses": { "204": { "description": "OK. The request to remove your worker pool was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is deleted.", "events": [ { "name": "containers-kubernetes.workerpool.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/removeWorkerPool\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"allowSingleOpenShiftWorker\": false,\n", " \"cluster\": \"example-value\",\n", " \"workerpool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/removeWorkerPoolZone": { "post": { "description": "Remove a zone from a worker pool in your cluster. All worker nodes that are deployed to that zone in the worker pool are deleted. The app pods from the deleted worker nodes are rescheduled to other worker nodes when the zone is removed. To avoid downtime, be sure that you have enough worker nodes to handle your workload.", "tags": [ "v2" ], "summary": "Remove a zone from a worker pool.", "operationId": "removeWorkerPoolZone", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveWorkerPoolZoneReq" } } }, "description": "The input parameter to specify the cluster, worker pool, and zone.", "required": true }, "x-codegen-request-body-name": "removeRequest", "responses": { "204": { "description": "OK. The request to remove the zone from your worker pool was successfully received..", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A zone is deleted from a worker pool.", "events": [ { "name": "containers-kubernetes.zone.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/removeWorkerPoolZone\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"workerpool\": \"example-value\",\n", " \"zone\": \"us-south-1\"\n", "}'\n" ] } ] } ] } } } }, "/v2/replaceWorker": { "post": { "description": "Delete the specified worker node from the cluster and create a new worker node in the same worker pool to replace the deleted worker node. The new worker node is assigned new public or private IP addresses. When the worker node is deleted, it is cordoned and drained to reschedule the pods that run on the worker node before deleting it, to avoid downtime for your apps. You might replace a worker node if you cannot reload or update the worker node, such as if it enters a troubled state.", "tags": [ "beta" ], "summary": "Replace a worker node with a new worker node.", "operationId": "replaceWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of a VPC cluster, use the `GET /v2/vpc/getCluster?cluster=idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceWorkerRequest" } } }, "description": "Input parameters to replace a worker.", "required": true }, "x-codegen-request-body-name": "replaceWorkerRequest", "responses": { "204": { "description": "OK. The worker node is being removed and replaced with a new worker node.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or worker could not be found. To list the VPC clusters that you have access to, use the `GET /vpc/v2/getClusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker node is removed and another worker node of the same flavor is created in the cluster.", "events": [ { "name": "containers-kubernetes.worker.replace" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/replaceWorker\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"update\": false,\n", " \"workerID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v2/resizeWorkerPool": { "post": { "description": "Resize a worker pool for the specified cluster, such as to add or remove worker pools from each zone that the worker pool spans. Resizing the worker pool resets the desired count of worker node per zone.", "tags": [ "v2" ], "summary": "Resize an existing worker pool.", "operationId": "v2ResizeWorkerPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResizeWorkerPool" } } }, "description": "The resize request.", "required": true }, "x-codegen-request-body-name": "resizeRequest", "responses": { "202": { "description": "Accepted. The worker pool will be resized to the specified value.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is resized, to add or decrease the number of worker nodes in the pool.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.resize" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/resizeWorkerPool\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"allowSingleOpenShiftWorker\": false,\n", " \"cluster\": \"example-value\",\n", " \"size\": 3,\n", " \"workerpool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/rotateClusterCOSKey": { "get": { "description": "Do not use it as this endpoint is not supported in the long term. Rotates the ROKS cluster's HMAC data.\n\nRotates the HMAC service key, key ID and key GUID associated to the cluster. If the bucket of the cluster doesn't exist it gets created firstly.`", "tags": [ "experimental" ], "summary": "Do not use it as this endpoint is not supported in the long term", "operationId": "RotateClusterCOSKey", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster of which you want to rotate the COS data. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. Indicates that the rotation was successful.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The query parameters are either incomplete or in the wrong format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The rotation of the COS data of the cluster.", "events": [ { "name": "containers-kubernetes.cluster-cos-key.rotate" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/rotateClusterCOSKey?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/satellite/createCluster": { "post": { "description": "Create an OpenShift Container Platform cluster in an IBM Cloud Satellite location. Creating a cluster requires Administrator access to Kubernetes Service in the IBM Cloud account. After you create a Satellite cluster, assign hosts to the cluster to add compute capacity for your workloads.", "tags": [ "satellite-cluster" ], "summary": "Create an IBM Cloud Satellite cluster.", "operationId": "CreateSatelliteCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to create the Satellite cluster in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/MultishiftCreateCluster" }, "x-codegen-request-body-name": "clusterConfig", "responses": { "201": { "description": "Created. The cluster was successfully created in the IBM Cloud Satellite location.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateClusterResponse" }, "example": { "id": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict. A cluster with the same name already exists. Choose another name for your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/createCluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/satellite/createClusterRemoteLocation": { "post": { "description": "Create an OpenShift Container Platform cluster in an IBM Cloud Satellite location that belongs to another account. Creating a cluster requires service-to-service IAM authorization in the target IBM Cloud account. After you create a Satellite cluster, the account owner is responsible for providing hosts to run the worker nodes.", "tags": [ "satellite-service" ], "summary": "Create an IBM Cloud Satellite cluster in a location that does not belong to y...", "operationId": "CreateSatelliteClusterRemote", "parameters": [ { "description": "The IBM Cloud Identity and Access Management (IAM) token for the account to create the cluster in. To retrieve the token, log in to the account and run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group the cluster is to be created in.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster. For the service CRN token to work for this API request, the user must previously authorize the service with the \"Satellite Cluster Creator\" action for Satellite in IAM for the IBM Cloud account where the Satellite location exists.", "name": "X-Auth-Supplemental", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/MultishiftCreateCluster" }, "x-codegen-request-body-name": "clusterConfig", "responses": { "201": { "description": "Created. The cluster was successfully created in the IBM Cloud Satellite location.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateClusterResponse" }, "example": { "id": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict. A cluster with the same name already exists. Choose another name for your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/createClusterRemoteLocation\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"key\": \"value\"}'\n" ] } ] } ] } } } }, "/v2/satellite/createController": { "post": { "description": "Create an IBM Cloud Satellite location in the IBM Cloud account that you are logged into. Creating a location requires Administrator access to Kubernetes Service in the IBM Cloud account.", "tags": [ "satellite-location" ], "summary": "Create an IBM Cloud Satellite location.", "operationId": "CreateSatelliteLocation", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to create the Satellite location in. To list available resource group IDs from the command line, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateController" } } }, "description": "The configuration details for your Satellite location, in JSON format.", "required": true }, "x-codegen-request-body-name": "controllerConfig", "responses": { "201": { "description": "Created. The location was successfully created in the IBM Cloud account that you are logged in to.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateControllerResponse" }, "example": { "crn": "example-value", "id": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict. A location with the same name already exists. Choose another name for your location.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/createController\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"calicoIPAutodetection\": {},\n", " \"capabilitiesManagedBySatellite\": [\n", " \"example-value\"\n", " ],\n", " \"coreos_enabled\": true,\n", " \"cos_config\": {\n", " \"bucket\": \"example-value\",\n", " \"endpoint\": \"https://example.com\",\n", " \"region\": \"us-south\",\n", " \"serviceInstance\": {\n", " \"crn\": \"example-value\"\n", " }\n", " },\n", " \"cos_credentials\": {\n", " \"access_key-id\": \"example-id-123\",\n", " \"secret_access_key\": \"example-value\"\n", " },\n", " \"description\": \"example-value\",\n", " \"iaas\": {\n", " \"credential\": [\n", " 1\n", " ],\n", " \"provider\": \"vpc-gen2\",\n", " \"region\": \"us-south\"\n", " },\n", " \"ingestion_keys\": {\n", " \"activity_tracker_key\": \"example-value\",\n", " \"logging_key\": \"example-value\"\n", " }\n", "}'\n" ] } ] } ] } } } }, "/v2/satellite/createWorkerPool": { "post": { "description": "Create a worker pool for the specified cluster in an IBM Cloud Satellite location. Creating a worker pool requires Operator access to Kubernetes Service in the IBM Cloud account. Specify the worker pool `flavor` as \"upi\" for user provided infrastructure. You can also use `hostLabels` key value pairs so that available hosts with matching labels in the IBM Cloud Satellite location are automatically assigned to the worker pool.", "tags": [ "satellite-cluster" ], "summary": "Create a worker pool for an IBM Cloud Satellite cluster.", "operationId": "CreateSatelliteWorkerPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SatelliteCreateWorkerPoolRequest" } } }, "description": "The configuration details for your worker pool, in JSON format.", "required": true }, "x-codegen-request-body-name": "workerPoolConfig", "responses": { "201": { "description": "Created. The worker pool was successfully created in the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkerpoolResponse" }, "example": { "workerPoolID": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "409": { "description": "Conflict. Another worker pool might be provisioning for the specified cluster. Wait a few minutes and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/createWorkerPool\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"Zones\": [\n", " {\n", " \"id\": \"example-id-123\"\n", " }\n", " ],\n", " \"cluster\": \"example-value\",\n", " \"diskEncryption\": false,\n", " \"entitlement\": \"example-value\",\n", " \"flavor\": \"example-value\",\n", " \"hostLabels\": {},\n", " \"isolation\": \"example-value\",\n", " \"labels\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/satellite/createWorkerPoolZone": { "post": { "description": "Create a zone in the specified worker pool for an IBM Cloud Satellite cluster. Worker nodes are provisioned in each zone based on the size per zone of the worker pool.", "tags": [ "satellite-cluster" ], "summary": "Create a zone in the specified worker pool for an IBM Cloud Satellite cluster.", "operationId": "CreateSatelliteWorkerPoolZone", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SatelliteWorkerPoolZoneAdd" } } }, "description": "Input parameters to add zones to the worker pool.", "required": true }, "x-codegen-request-body-name": "workerZoneConfig", "responses": { "201": { "description": "OK. The requested zone was added to the worker pool.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker pool could not be found. To list all worker pools for a cluster, use the `GET /v2/getWorkerPools` API or run `ibmcloud ks worker-pool ls -c `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The provided zone already exists in the worker pool.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/createWorkerPoolZone\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"id\": \"example-id-123\",\n", " \"workerpool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/satellite/getClusters": { "get": { "description": "List the IBM Cloud Satellite clusters that you have access to.", "tags": [ "satellite-cluster" ], "summary": "List the IBM Cloud Satellite clusters that you have access to.", "operationId": "GetSatelliteClusters", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of clusters that you have access to is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetClustersResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "createdDate": "example-value", "datacenter": "example-value", "desiredTrustedProfileID": "example-id-123", "entitlement": "example-value", "etcdPort": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/satellite/getClusters\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/satellite/getController": { "get": { "description": "Get the details for an IBM Cloud Satellite location.", "tags": [ "satellite-location" ], "summary": "Get the details for an IBM Cloud Satellite location.", "operationId": "GetSatelliteLocation", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the location to get information about.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list available resource group IDs from the command line, run `ibmcloud resource groups`. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. The details of the requested IBM Satellite location are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftGetController" }, "example": { "activityTrackerKeyProvided": false, "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "capabilitiesManagedBySatellite": [ "example-value" ], "coreosEnabled": true, "cos_config": { "bucket": "example-value", "endpoint": "https://example.com", "region": "us-south", "serviceInstance": { "crn": "example-value" } }, "createdDate": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite location. To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/satellite/getController?controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/satellite/getControllers": { "get": { "description": "List the IBM Cloud Satellite locations that you have access to.", "tags": [ "satellite-location" ], "summary": "List the IBM Cloud Satellite locations that you have access to.", "operationId": "GetSatelliteLocations", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to filter Satellite locations for. To list available resource group IDs from the command line, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of locations that you have access to is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultishiftController" }, "minItems": 0, "maxItems": 100 }, "example": [ { "activityTrackerKeyProvided": false, "capabilitiesManagedBySatellite": [ "example-value" ], "coreosEnabled": true, "createdDate": "example-value", "crn": "example-value", "deployments": { "enabled": true, "message": "example-value" }, "hostUpdateSeverity": "example-value", "hosts": { "available": 1, "total": 1 } } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/satellite/getControllers\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/satellite/getServiceClusters": { "get": { "description": "List the clusters that are associated with a Satellite-enabled service that you deployed to your IBM Cloud Satellite location. The clusters in this list are managed by IBM Cloud to provide the cloud service in the location, but you still provide the hosts to run the clusters.", "tags": [ "satellite-service" ], "summary": "List the clusters in an IBM Cloud Satellite location that are associated with...", "operationId": "GetSatelliteServiceClusters", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the location to list services.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of Satellite-enabled service clusters that you have access to is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/multishiftClustersResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "createdDate": "example-value", "datacenter": "example-value", "desiredTrustedProfileID": "example-id-123", "entitlement": "example-value", "etcdPort": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/satellite/getServiceClusters?controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/satellite/hostqueue/createAssignment": { "post": { "description": "Assign a host to an IBM Cloud Satellite location or cluster. Before you can assign hosts to clusters, first assign at least three hosts to the Satellite location, to run control plane operations. Then, when you have Satellite clusters, you can assign hosts as needed to provide compute resources for your workloads. You can assign hosts by specifying a host ID or by providing labels to match hosts to your request.", "tags": [ "satellite-host" ], "summary": "Assign a host to an IBM Cloud Satellite location or cluster.", "operationId": "CreateSatelliteAssignment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateAssignment" } } }, "description": "The configuration details to assign a host to an IBM Cloud Satellite resource, in JSON format. The \"cluster\" field (required) indicates the name or ID of the IBM Cloud Satellite resource to assign the host. The resource can be the name or ID of the Satellite location itself, or an IBM Cloud Satellite cluster. If \"hostID\" is specified, that host is assigned if it is available. If a set of \"labels\" is specified, all the available hosts are scanned to find a host that matches all the labels. If neither \"hostID\" nor \"labels\" are specified, a random available host is assigned.", "required": true }, "x-codegen-request-body-name": "assignmentConfig", "responses": { "201": { "description": "Created. A host was successfully assigned to your IBM Cloud Satellite resource.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateAssignmentResponse" }, "example": { "hostID": "example-id-123", "id": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite location. To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. Could not find any available hosts that match your requested host ID or label parameters.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/hostqueue/createAssignment\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"controller\": \"example-value\",\n", " \"hostID\": \"example-id-123\",\n", " \"labels\": {},\n", " \"workerpool\": \"example-value\",\n", " \"zone\": \"us-south-1\"\n", "}'\n" ] } ] } ] } } } }, "/v2/satellite/hostqueue/createRegistrationScript": { "post": { "description": "Create a script to run on a Red Hat Enterprise Linux 7 host in your on-premises infrastructure. The script attaches the host to your IBM Cloud Satellite location. The host must have access to the public network in order for the script to complete.", "tags": [ "satellite-host" ], "summary": "Attach a host to an IBM Cloud Satellite location.", "operationId": "AttachSatelliteHost", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftNodeQueue" } } }, "description": "The configuration details to create an attachment script for your Satellite location, in JSON format. The \"labels\" field (required) is a set of key-value pairs to describe your host, such as cpu=4. Later, when you assign a host to IBM Cloud Satellite resources, these labels are used to match your host with your request.", "required": true }, "x-codegen-request-body-name": "attachConfig", "responses": { "201": { "description": "Created. The response contains a script that you can run on your host to attach the host to your IBM Cloud Satellite location.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "text/plain": { "schema": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite location. To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/hostqueue/createRegistrationScript\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"controller\": \"example-value\",\n", " \"labels\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/satellite/hostqueue/getHosts": { "get": { "description": "List the hosts in your IBM Cloud Satellite location.", "tags": [ "satellite-host" ], "summary": "List the hosts in your IBM Cloud Satellite location.", "operationId": "GetSatelliteHosts", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The ID of the location to to retrieve hosts from.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of hosts in your IBM Cloud Satellite location is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultishiftQueueNode" }, "minItems": 0, "maxItems": 100 }, "example": [ { "assignment": { "clusterID": "example-id-123", "clusterName": "my-cluster", "ipAddress": "example-value", "receivedDate": "example-value", "requestedDate": "example-value", "updateSeverity": "example-value", "workerID": "example-id-123", "workerPoolID": "example-id-123" }, "health": { "message": "example-value", "modifiedDate": "example-value", "status": "example-value" }, "id": "example-id-123", "labels": {}, "name": "my-cluster", "state": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite location. To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/satellite/hostqueue/getHosts?controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/satellite/hostqueue/removeHost": { "post": { "description": "Remove a host from an IBM Cloud Satellite resource, such as a cluster. The host is removed from the resource and no longer available in IBM Cloud Satellite. However, if you want, you must still delete the host machine in the underlying infrastructure provider. Before you can remove a host, you must remove the worker node that runs on the host. To check worker nodes on the host, use the `GET /v2/satellite/hostqueue/getHosts` API or run `ibmcloud sat host ls`. To remove a worker node, run `ibmcloud ks worker rm -c -w `.", "tags": [ "satellite-host" ], "summary": "Remove a host from an IBM Cloud Satellite location or cluster.", "operationId": "RemoveSatelliteHost", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftRemoveNode" } } }, "description": "The configuration details to remove a host from an IBM Cloud Satellite location, in JSON format.", "required": true }, "x-codegen-request-body-name": "assignmentConfig", "responses": { "204": { "description": "OK. The host was successfully removed from your IBM Cloud Satellite location.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Could not find the host. To list available hosts, use the `GET /v2/satellite/hostqueue/getHosts` API or run `ibmcloud sat host ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. Cannot remove the host because a worker node runs on the host. Remove the worker node and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/hostqueue/removeHost\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"controller\": \"example-value\",\n", " \"hostID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v2/satellite/hostqueue/updateHost": { "post": { "description": "Update the labels of a host in your IBM Cloud Satellite location. You can apply a new set of labels only to hosts that are not already assigned to an IBM Cloud Satellite resource.", "tags": [ "satellite-host" ], "summary": "Update a host in your IBM Cloud Satellite location.", "operationId": "UpdateSatelliteHost", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftUpdateNode" } } }, "description": "The configuration details to update a host to an IBM Cloud Satellite resource, in JSON format.", "required": true }, "x-codegen-request-body-name": "assignmentConfig", "responses": { "204": { "description": "OK. The host was successfully updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Could not find the host. To list available hosts, use the `GET /v2/satellite/hostqueue/getHosts` API or run `ibmcloud sat host ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The labels cannot be updated because the host is already assigned to an IBM Cloud Satellite resource, such as a cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Satellite is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/hostqueue/updateHost\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"controller\": \"example-value\",\n", " \"hostID\": \"example-id-123\",\n", " \"labels\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/satellite/removeController": { "post": { "description": "Remove an IBM Cloud Satellite location. Before you can remove a location, you must remove any Satellite clusters and the underlying host machines. To list the hosts in your location, run `ibmcloud sat hosts --location ` and check the Cluster and Worker details in the output.", "tags": [ "satellite-location" ], "summary": "Remove an IBM Cloud Satellite Location.", "operationId": "RemoveSatelliteLocation", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateClusterFragment" } } }, "description": "The IBM Satellite location to remove." }, "x-codegen-request-body-name": "removeRequest", "responses": { "204": { "description": "OK. The request to remove your IBM Cloud Satellite location was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite location. To list available locations, use the `GET /v2/satellite/getControllers` API, or run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. Cannot delete an IBM Cloud Satellite location that has active clusters. To list the clusters in the Satellite location, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/satellite/removeController\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"calicoIPAutodetection\": {},\n", " \"controller\": \"example-value\",\n", " \"infrastructureTopology\": \"public\",\n", " \"networkPlugin\": \"calico\",\n", " \"pullSecret\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/setPodSecurity": { "post": { "description": "Set the Pod Security admission controller configuration.", "tags": [ "pod-security" ], "summary": "Set the Pod Security admission controller configuration.", "operationId": "V2SetPodSecurity", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPodSecurityRequest" } } }, "description": "The cluster to target.", "required": true }, "x-codegen-request-body-name": "setRequest", "responses": { "204": { "description": "OK. The request to set the Pod Security admission controller configuration was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format. \\\nBad Request. Your cluster must run Kubernetes version 1.24 or later to modify the Pod Security admission configuration. \\\nBad Request. Pod Security admission is not supported for Red Hat OpenShift clusters.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } } }, "x-ibm-events": { "description": "The Pod Security admission controller configuration is updated.", "events": [ { "name": "containers-kubernetes.cluster-pod-security.set" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.update" } ], "description": "To change the Pod Security admission controller configuration, you must have the Administrator platform role for the Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/setPodSecurity\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"configuration\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/setWorkerPoolLabels": { "post": { "description": "Set custom labels for a worker pool and each of its worker nodes. You might use labels to restrict a workload to run on only this worker pool, or to apply a taint so that workloads do not run on the worker pool. To confirm that your custom labels are applied, run `ibmcloud ks worker-pool get -c `. To check the labels of the worker nodes, get the private IP address of the worker node (`ibmcloud ks worker ls -c `) and run `kubectl describe node `. Note that you must not edit the system-provided labels that that come with the worker pool and worker nodes by default, or you might experience unexpected results.", "tags": [ "v2" ], "summary": "Set custom labels for a worker pool.", "operationId": "v2SetWorkerPoolLabels", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWorkerPoolLabels" } } }, "description": "Labels to apply to the worker pool and each of its worker nodes. To apply a custom label to the worker pool, set the \"state\" field to \"labels\" and fill in the \"labels\" section with your label key-value pairs. When you apply a label, all existing custom labels are replaced. If you have existing custom labels that you want to keep, include them in your request. To remove a custom label, set the \"state\" field to \"labels\" and in the \"labels\" section, include the same \"key\" field, but leave the value field blank \"\". Note that you must not edit the system-provided labels that that come with the worker pool and worker nodes by default, or you might experience unexpected results.", "required": true }, "x-codegen-request-body-name": "setWorkerPoolLabelsRequest", "responses": { "204": { "description": "OK. The request to set the labels of the worker pool was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Kubernetes labels for a worker pool are set. Existing and future worker nodes in the worker pool inherit the label.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool-label.set" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/setWorkerPoolLabels\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"labels\": {},\n", " \"workerpool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/setWorkerPoolOperatingSystem": { "post": { "description": "Set the operating system of a worker pool. To confirm that your modification is applied, check the details of a worker pool (`ibmcloud ks worker-pool get --cluster CLUSTER --worker-pool POOL`).", "tags": [ "v2" ], "summary": "Set the operating system of a worker pool.", "operationId": "v2SetWorkerPoolOperatingSystem", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster belongs to in which the worker pools resides. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWorkerPoolOperatingSystem" } } }, "description": "Sets the operating system of a worker pool.", "required": true }, "x-codegen-request-body-name": "setWorkerPoolOperatingSystemRequest", "responses": { "202": { "description": "OK. The request to set the operating system of the worker pool was successful.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "The worker pool's operating system is not suitable for an upgrade this way.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "The specified worker pool could not be found..", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Kubernetes taints for a worker pool are set. Existing and future worker nodes in the worker pool inherit the taint.", "events": [ { "name": "cluster-worker-pool-operating-system.set" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/setWorkerPoolOperatingSystem\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"operatingSystem\": \"example-value\",\n", " \"workerPool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/setWorkerPoolTaints": { "post": { "description": "Set custom taints for a worker pool and each of its worker nodes. You might use taints so that workloads do not run on the worker pool. To confirm that your custom taints are applied, check the taints of the worker nodes by getting the private IP address of the worker node (`ibmcloud ks worker ls -c `) and run `kubectl describe node `.", "tags": [ "v2" ], "summary": "Set custom taints for a worker pool.", "operationId": "v2SetWorkerPoolTaints", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v2/getCluster` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWorkerPoolTaints" } } }, "description": "Taints to apply to the worker pool and each of its worker nodes. To apply a custom taint to the worker pool, set the \"state\" field to \"taints\" and fill in the \"taints\" section with your taint key-value pairs where the value contains the taint value and the taint effect separated by a \":\" with valid taint effects being \"NoSchedule\", \"PreferNoSchedule\", and \"NoExecute\". When you apply a taint, all existing custom taints are replaced. If you have existing custom taints that you want to keep, include them in your request. To remove a custom taint, set the \"state\" field to \"taints\" and in the \"taints\" section, include the same \"key\" field, but leave the value field blank \"\".", "required": true }, "x-codegen-request-body-name": "setWorkerPoolTaintsRequest", "responses": { "204": { "description": "OK. The request to set the taints of the worker pool was successfully received.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Kubernetes taints for a worker pool are set. Existing and future worker nodes in the worker pool inherit the taint.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool-taint.set" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/setWorkerPoolTaints\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"taints\": {},\n", " \"workerpool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/createAttachment": { "post": { "description": "Create volume attachment for a given worker", "tags": [ "storage" ], "operationId": "createAttachment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster-get `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cluster": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volumeID": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "worker": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } } } } }, "description": "The config includes ID of the cluster, ID of the worker on which you want to attach a volume, and the unique volume ID of the volume to be attached to a worker. To list the clusters that you have access to, run `ibmcloud ks clusters`. To list all worker nodes for a cluster, run `ibmcloud ks workers `. To list the volumes that you have access to, run `ibmcloud is vols`.", "required": true }, "x-codegen-request-body-name": "storage-volume-attachment-config", "responses": { "201": { "description": "Ok. Attach request successfully accepted.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeAttachment" }, "example": { "device": { "id": "example-id-123" }, "id": "example-id-123", "name": "my-cluster", "status": "example-value", "type": "example-value", "volume": { "accountId": "example-id-123", "capacity": 1, "cluster": "example-value", "clusterstatus": "example-value", "created_at": "example-value", "crn": "example-value", "datacenter": "example-value", "delete_cluster_resources": "example-value" } } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker could not be found. To list the workers, use the `GET /v2/vpc/getWorkers` API or run `ibmcloud ks workers --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/createAttachment\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"volumeID\": \"example-id-123\",\n", " \"worker\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/deleteAttachment": { "post": { "tags": [ "storage" ], "summary": "Detach volume from given worker.", "operationId": "deleteAttachment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster-get `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPCVolumeAttachmentConfig" } } }, "description": "The config includes ID of the cluster, ID of the worker from which you want to detach volume, and the unique volume attachment ID for the attached volume. To list the clusters that you have access to, run `ibmcloud ks clusters`. To list all worker nodes for a cluster, run `ibmcloud ks workers `.", "required": true }, "x-codegen-request-body-name": "storage-volume-attachment-config", "responses": { "201": { "description": "Ok. detach request successfully accepted.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker could not be found. To list the workers, use the `GET /v2/vpc/getWorkers` API or run `ibmcloud ks workers --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/deleteAttachment\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"volumeAttachmentID\": \"example-id-123\",\n", " \"volumeID\": \"example-id-123\",\n", " \"worker\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/getAttachment": { "get": { "description": "Get the volume attachment detail for given volume attachment ID", "tags": [ "storage" ], "operationId": "getAttachment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster-get `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The ID or name of the cluster. To list the clusters that you have access to, run `ibmcloud ks clusters`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node, whose volume attachments needs to be listed. To list all worker nodes for a cluster, run `ibmcloud ks workers `.", "name": "worker", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The unique volume attachment ID for the attached volume", "name": "volume_attachment_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeAttachment" }, "example": { "device": { "id": "example-id-123" }, "id": "example-id-123", "name": "my-cluster", "status": "example-value", "type": "example-value", "volume": { "accountId": "example-id-123", "capacity": 1, "cluster": "example-value", "clusterstatus": "example-value", "created_at": "example-value", "crn": "example-value", "datacenter": "example-value", "delete_cluster_resources": "example-value" } } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker could not be found. To list the workers, use the `GET /v2/vpc/getWorkers` API or run `ibmcloud ks workers --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/getAttachment?cluster=example-value&worker=example-value&volume_attachment_id=example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/getAttachments": { "get": { "description": "Get the volume attachments detail for a given worker", "tags": [ "storage" ], "operationId": "getAttachments", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster-get `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The ID or name of the cluster. To list the clusters that you have access to, run `ibmcloud ks clusters`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node, whose volume attachments needs to be listed.", "name": "worker", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeAttachmentList" }, "example": { "volume_attachments": [ { "device": { "id": "example-id-123" }, "id": "example-id-123", "name": "my-cluster", "status": "example-value", "type": "example-value", "volume": { "accountId": "example-id-123", "capacity": 1, "cluster": "example-value", "clusterstatus": "example-value", "created_at": "example-value", "crn": "example-value", "datacenter": "example-value", "delete_cluster_resources": "example-value" } } ] } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker could not be found. To list the workers, use the `GET /v2/vpc/getWorkers` API or run `ibmcloud ks workers --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/getAttachments?cluster=example-value&worker=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/getVolume": { "get": { "tags": [ "storage" ], "summary": "Get the details of a storage volume.", "operationId": "GetVolume", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster-get `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "schema": { "type": "string" } }, { "description": "The unique volume ID. To list the volume ID, use the `GET /v2/storage/classic/getVolumes` API or run `ibmcloud ks storage volume ls classic`.", "name": "volume_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok.", "headers": { "X-Request-Id": { "description": "The unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volume" }, "example": { "accountId": "example-id-123", "capacity": 1, "cluster": "example-value", "clusterstatus": "example-value", "created_at": "example-value", "crn": "example-value", "datacenter": "example-value", "delete_cluster_resources": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker could not be found. To list the workers, use the `GET /v2/vpc/getWorkers` API or run `ibmcloud ks workers --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/getVolume?volume_id=example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/getVolumes": { "get": { "tags": [ "storage" ], "summary": "List storage volumes for a cluster or for the account if no cluster is provided.", "operationId": "GetVolumes", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "schema": { "type": "string" } }, { "description": "The unique ID of your IBM Cloud resource group when you created your cluster. To see the cluster's resource group ID, run `ibmcloud ks cluster-get `.", "name": "X-Auth-Resource-Group-ID", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID or name of the classic cluster. To list the clusters that you have access to, run `ibmcloud ks cluster ls --provider classic`.", "name": "cluster", "in": "query", "schema": { "type": "string" } }, { "description": "Filter the list for a specific infrastructure provider. Supported values are classic, vpc-classic, and vpc-gen2.", "name": "provider", "in": "query", "schema": { "type": "string" } }, { "description": "The zone to filter volume results by. To list available zones, run `ibmcloud ks locations`.", "name": "zone", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok.", "headers": { "X-Request-Id": { "description": "The unique ID for this request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesList" }, "example": { "volumes": [ { "accountId": "example-id-123", "capacity": 1, "cluster": "example-value", "clusterstatus": "example-value", "created_at": "example-value", "crn": "example-value", "datacenter": "example-value", "delete_cluster_resources": "example-value" } ] } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker could not be found. To list the workers, use the `GET /v2/vpc/getWorkers` API or run `ibmcloud ks workers --cluster `.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/getVolumes\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/ackDesiredStorageConfigCapacity": { "patch": { "description": "Acknowledge the request to expand the storage capacity of an existing storage request.", "tags": [ "storage", "satellite" ], "summary": "Acknowledge the request to expand storage capacity.", "operationId": "ackDesiredStorageConfigCapacity", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AckDesiredStorageCapacityRequest" } } }, "description": "Include the ID of the storage request (`request-id`), the cluster ID (`cluster`) and the name or ID of the Satellite location (`controller`) that the cluster is registered to.\nTo list storage requests, use the `/v2/satellite/getDesiredStorageConfig` API.\nTo list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`.\n", "required": true }, "x-codegen-request-body-name": "satellite-acknowledge-desired-storage-capacity-request", "responses": { "201": { "description": "OK. The storage request is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "The specified cluster or storage request could not be found. Check the input parameters and try again. Verify the input parameters and retry the request. To list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`. To list storage requests, use the `/v2/satellite/getDesiredStorageConfig` API.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage capacity expansion request is acknowledged.", "events": [ { "name": "satellite.storage-configuration.ack-desired-capacity" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" } ], "description": "To get the action, the user must have the Read Satellite Location access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v2/storage/satellite/ackDesiredStorageConfigCapacity\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"controller\": \"example-value\",\n", " \"request-id\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/createAssignment": { "post": { "description": "Create an assignment to install the storage driver that is described by the version of the storage configuration on the cluster group(s). Then, apps that run in the clusters, part of cluster group(s), can use the storage.", "tags": [ "storage", "satellite" ], "summary": "Create an assignment using a Satellite storage configuration for the cluster ...", "operationId": "createAssignment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionInputData" } } }, "description": "Include following parameters to create an assignment:\n 1. Name of the assignment (`name`).\n 2. Storage configuration name or ID (`config`). To list the storage configurations that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurations` API or run `ibmcloud sat storage config ls`.\n 3. The name or ID of the Satellite location (`controller`). To list the Satellite locations that you have access to, use the `GET /v2/satellite/getControllersAPI` or run `ibmcloud sat location ls`.\n 4. One or more cluster groups (`groups`) on which you want to apply the configuration. Note that at least one cluster group is required. To list the cluster groups that you have access to, run `ibmcloud sat group ls`.\n 5. Enable or disable automatic upgrades for the assignment (`autoUpgrade=\"true|false\"`).\n", "required": true }, "x-codegen-request-body-name": "assignment-params", "responses": { "200": { "description": "OK. An assignment using the storage configuration is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionData" }, "example": { "addSubscription": { "message": "example-value", "recoveryCLI": "example-value", "uuid": "example-id-123" } } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified config or cluster group(s) could not be found. To list the storage configurations that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurations` API or run `ibmcloud sat storage config ls`. To list the Satellite cluster groups you have access to, run `ibmcloud sat group ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An assignment is created.", "events": [ { "name": "satellite.subscription.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.create" } ], "description": "To get the action, the user must have the Satellite Config Subscription Create access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/satellite/createAssignment\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"autoUpgrade\": \"example-value\",\n", " \"config\": \"example-value\",\n", " \"controller\": \"example-value\",\n", " \"groups\": [\n", " \"example-value\"\n", " ],\n", " \"name\": \"my-cluster\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/createAssignmentByCluster": { "post": { "description": "Create an assignment to install the storage driver described by the version of the storage configuration on the Satellite cluster or service cluster. Then, apps that run in the cluster can use the storage.", "tags": [ "storage", "satellite" ], "summary": "Create an assignment using a Satellite storage configuration for a Satellite ...", "operationId": "createAssignmentByCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionByClusterInputData" } } }, "description": "Include following parameters to create an assignment:\n 1. Name of the assignment (`name`).\n 2. Storage configuration name or ID (`config`). To list the storage configurations for a location that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurationsByController` API or run `ibmcloud sat storage config ls --location LOCATION`.\n 3. ID of the Satellite cluster or service cluster that you want to apply the configuration to (`cluster`). To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.\n 4. The name or ID of the Satellite location (`controller`). To list the Satellite locations that you have access to, use the `GET /v2/satellite/getControllersAPI` or run `ibmcloud sat location ls`.\n 5. Enable or disable automatic upgrades for the assignment (`autoUpgrade=\"true|false\"`).\n", "required": true }, "x-codegen-request-body-name": "assignment-params", "responses": { "200": { "description": "OK. An assignment using the storage configuration is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionData" }, "example": { "addSubscription": { "message": "example-value", "recoveryCLI": "example-value", "uuid": "example-id-123" } } } } }, "400": { "description": "Bad Request. The specified cluster is neither a Satellite cluster nor a service cluster. To list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified config or cluster or location could not be found. To list the storage configurations for the location that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurationsByController` API or run `ibmcloud sat storage config ls --location LOCATION`. To list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An assignment is created for a given cluster.", "events": [ { "name": "satellite.subscription.create-by-cluster" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.create" } ], "description": "To get the action, the user must have the Satellite Config Subscription Create access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/satellite/createAssignmentByCluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"autoUpgrade\": \"example-value\",\n", " \"cluster\": \"example-value\",\n", " \"config\": \"example-value\",\n", " \"controller\": \"example-value\",\n", " \"name\": \"my-cluster\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/createStorageConfiguration": { "post": { "description": "Create a Satellite storage configuration based off the storage template, custom parameters, and location that you want to use. Then, assign the storage configuration to your clusters to install the storage driver so that the apps that run in the cluster can use the storage.", "tags": [ "storage", "satellite" ], "summary": "Deprecated. To create a Satellite storage configuration, you can use /v2/stor...", "operationId": "createStorageConfiguration", "deprecated": true, "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageConfigCreateInput" } } }, "description": "Include a name for the storage configuration (`config-name`), the storage template name (`storage-template-name`), version (`storage-template-version`), required parameters as per the template specified (`user-config-parameters`, `user-secret-parameters`, and/or `storage-class-parameters`) and the Satellite location (`location`) where you want to use the storage configuration. To list the storage templates and template versions, run `ibmcloud sat storage template ls`. To list the parameters for a given storage template and template version, run `ibmcloud sat storage template get --name= --version=`. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "required": true }, "x-codegen-request-body-name": "storageConfigCreateInput", "responses": { "201": { "description": "OK. The storage configuration is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConfigurationData" }, "example": { "addChannel": { "uuid": "example-id-123" } } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/satellite/createStorageConfiguration\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"config-name\": \"my-cluster\",\n", " \"controller\": \"example-value\",\n", " \"storage-class-parameters\": [\n", " {}\n", " ],\n", " \"storage-template-name\": \"my-cluster\",\n", " \"storage-template-version\": \"1.28.5\",\n", " \"user-config-parameters\": {},\n", " \"user-secret-parameters\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/createStorageConfigurationByController": { "post": { "description": "Create a Satellite storage configuration based on the storage template, custom parameters, and location that you want to use. After you create the configuration, install the storage driver by assigning the configuration to your clusters or cluster groups with the `/v2/storage/satellite/createAssignmentByCluster` or `/v2/storage/satellite/createAssignment` APIs.", "tags": [ "storage", "satellite" ], "summary": "Create a Satellite storage configuration", "operationId": "createStorageConfigurationByController", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageConfigCreateInput" } } }, "description": "Include a name for the storage configuration (`config-name`); the storage template name (`storage-template-name`), version (`storage-template-version`) (optionally; if unspecified, the default storage template version is picked), required parameters as per the template specified (`user-config-parameters`, `user-secret-parameters`, and/or `storage-class-parameters`) and ID of the Satellite location (`controller`) where you want to use the storage configuration. The `update-assignments` payload parameter may be ignored.\n\nEnter a storage configuration name that is less than 253 characters long and contains only lowercase letters, numbers, `-`, or `.`.\n\nTo list the storage templates and template versions that you have access to, run `ibmcloud sat storage template ls`.\nTo list the parameters for a given storage template and template version, run `ibmcloud sat storage template get --name= --version=`.\nTo list the Satellite locations that you have access to, run `ibmcloud sat location ls`.\n", "required": true }, "x-codegen-request-body-name": "storageConfigCreateInput", "responses": { "201": { "description": "OK. The storage configuration is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConfigurationData" }, "example": { "addChannel": { "uuid": "example-id-123" } } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage configuration is created.", "events": [ { "name": "satellite.storage-configuration.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-configuration.update" } ], "description": "To get the action, the user must have the Satellite Config Configuration Update access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/satellite/createStorageConfigurationByController\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"config-name\": \"my-cluster\",\n", " \"controller\": \"example-value\",\n", " \"storage-class-parameters\": [\n", " {}\n", " ],\n", " \"storage-template-name\": \"my-cluster\",\n", " \"storage-template-version\": \"1.28.5\",\n", " \"user-config-parameters\": {},\n", " \"user-secret-parameters\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/expandDesiredStorageConfigCapacity": { "patch": { "description": "Expand the capacity of an existing storage request. Specify the storage request that you want to expand, the cluster it is associated with, and the desired total capacity. Note that capacity expansion is subject to acknowledgement from the Satellite location administator.\n\nTo check if the Satellite location administrator has acknowledged the capacity expansion for a given storage request, use the `/v2/satellite/getDesiredStorageConfig` API. After the capacity expansion is acknowledged, the `status` field in the `backend` section of the `/v2/satellite/getDesiredStorageConfig` API response is set to `completed`.", "tags": [ "storage", "satellite" ], "summary": "Expand the capacity of a storage request.", "operationId": "expandDesiredStorageConfigCapacity", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpandDesiredStorageCapacityRequest" } } }, "description": "Include the ID of the storage request (`request-id`), the cluster ID (`cluster`) on which it is placed, and the desired total capacity (`total-capacity`). Specify the desired total capacity as a positive integer value in kilobytes (`K`), megabytes (`M`), gigabytes (`G`), terabytes (`T`) or exabytes (`E`). For example, specify `100G` for 100 GB.\nTo list storage requests, use the `/v2/satellite/getDesiredStorageConfig` API.\nTo list the Satellite clusters you have access to, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`.\n", "required": true }, "x-codegen-request-body-name": "satellite-expand-desired-storage-capacity-request", "responses": { "201": { "description": "OK. The storage request is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "The specified cluster or storage request could not be found. Check the input parameters and try again. To list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`. To list storage requests, use the `/v2/satellite/getDesiredStorageConfig` API.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The desired capacity of a storage request is increased.", "events": [ { "name": "satellite.storage-configuration.expand-desired" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v2/storage/satellite/expandDesiredStorageConfigCapacity\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"request-id\": \"example-id-123\",\n", " \"total-capacity\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAssignedStorageConfigs": { "get": { "description": "List Satellite storage configurations that are assigned to a Satellite cluster or service cluster.", "tags": [ "storage", "satellite" ], "summary": "List Satellite storage configurations assigned to a Satellite cluster or serv...", "operationId": "getAssignedStorageConfigs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "ID of the Satellite cluster or service cluster to list the assigned storage configurations for. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location that the cluster is registered to. To list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Assigned Satellite storage configurations are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppliedStorageConfig" }, "minItems": 0, "maxItems": 100 }, "example": [ { "assignment-uuid": "example-id-123", "config-attributes": { "offering-name": "my-cluster", "provider": "vpc-gen2", "storage-classes": [ "example-value" ], "template-name": "my-cluster", "template-version": "1.28.5", "total-capacity": "example-value", "volume-availability": "example-value", "volume-encryption-at-rest": "example-value" }, "config-name": "my-cluster", "config-uuid": "example-id-123", "rollout-status": { "error-count": 3, "success-count": 3 } } ] } } }, "400": { "description": "Bad Request. The request failed due to one of the following reasons:\n1. The cluster is missing or the specified cluster is invalid.\n2. The specified cluster is neither a Satellite cluster nor a service cluster.\nTo list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } ] } } }, "404": { "description": "Not found. The specified cluster or location could not be found. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Assigned storage configuration details is returned.", "events": [ { "name": "satellite.storage-configuration.get-assigned" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" }, { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Read Satellite Location access or the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAssignedStorageConfigs?cluster=example-value&controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAssignment": { "get": { "description": "View details of an assignment by the assignment UUID.", "tags": [ "storage", "satellite" ], "summary": "View details of an assignment.", "operationId": "getAssignment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The UUID of the assignment. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "name": "uuid", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Assignment details are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" }, "example": { "channelName": "my-cluster", "channelUuid": "example-id-123", "cluster": "example-value", "clusterName": "my-cluster", "configRevisionStatus": { "isRevisionUpdateAvailable": false, "latestRevision": "example-value", "revision": "example-value" }, "created": "example-value", "groups": [ "example-value" ], "isAssignmentUpgradeAvailable": false } } } }, "400": { "description": "Bad Request. Either the uuid is missing or the specified uuid is invalid. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified assignment could not be found. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of assignment are retrieved.", "events": [ { "name": "satellite.subscription.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.read" } ], "description": "To get the action, the user must have the Satellite Config Subscription Read access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAssignment?uuid=example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAssignmentByName": { "get": { "description": "View details of an assignment by the assignment name.", "tags": [ "storage", "satellite" ], "summary": "Deprecated. To view details of an assignment, you can use /v2/storage/satelli...", "operationId": "getAssignmentByName", "deprecated": true, "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name of the assignment. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Assignment details successfully fetched.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" }, "example": { "channelName": "my-cluster", "channelUuid": "example-id-123", "cluster": "example-value", "clusterName": "my-cluster", "configRevisionStatus": { "isRevisionUpdateAvailable": false, "latestRevision": "example-value", "revision": "example-value" }, "created": "example-value", "groups": [ "example-value" ], "isAssignmentUpgradeAvailable": false } } } }, "400": { "description": "Bad Request. Either the name is missing or the specified name is invalid. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified assignment could not be found. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An assignment is retrieved.", "events": [ { "name": "satellite.subscription.get-by-name" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.read" } ], "description": "To get the action, the user must have the Satellite Config Subscription Read access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAssignmentByName?name=my-cluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAssignments": { "get": { "description": "List storage assignments that you have access to in the IBM Cloud account. Returned details include the assignment name, UUID, and creation timestamp.", "tags": [ "storage", "satellite" ], "summary": "List storage assignments in the IBM Cloud account.", "operationId": "getAssignments", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Assignments are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" }, "minItems": 0, "maxItems": 100 }, "example": [ { "channelName": "my-cluster", "channelUuid": "example-id-123", "cluster": "example-value", "clusterName": "my-cluster", "configRevisionStatus": { "isRevisionUpdateAvailable": false, "latestRevision": "example-value", "revision": "example-value" }, "created": "example-value", "groups": [ "example-value" ], "isAssignmentUpgradeAvailable": false } ] } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A list of assignments is retrieved.", "events": [ { "name": "satellite.subscription.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.read" } ], "description": "To get the action, the user must have the Satellite Config Subscription Read access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAssignments\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAssignmentsByClusterID": { "get": { "description": "List storage assignments created for a Satellite cluster or service cluster. Returned details include the assignment name, UUID, and creation timestamp.", "tags": [ "storage", "satellite" ], "summary": "List storage assignments created for a Satellite cluster or service cluster.", "operationId": "getAssignmentsByClusterID", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "ID of the Satellite cluster or service cluster to list the storage assignments for. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location that the cluster is registered to. To list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Assignments are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" }, "minItems": 0, "maxItems": 100 }, "example": [ { "channelName": "my-cluster", "channelUuid": "example-id-123", "cluster": "example-value", "clusterName": "my-cluster", "configRevisionStatus": { "isRevisionUpdateAvailable": false, "latestRevision": "example-value", "revision": "example-value" }, "created": "example-value", "groups": [ "example-value" ], "isAssignmentUpgradeAvailable": false } ] } } }, "400": { "description": "Bad Request. The request failed due to one of the following reasons:\n1. The cluster is missing or the specified cluster is invalid.\n2.The specified cluster is neither a Satellite cluster nor a service cluster.\nTo list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or location could not be found. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A list of assignments is retrieved by using the cluster ID.", "events": [ { "name": "satellite.subscription.get-by-clusterid" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" }, { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Read Satellite Location access or the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAssignmentsByClusterID?cluster=example-value&controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAssignmentsByConfig": { "get": { "description": "List storage assignments by configuration name or UUID. Returned details include the assignment name, UUID, and creation timestamp.", "tags": [ "storage", "satellite" ], "summary": "List storage assignments by configuration name or UUID.", "operationId": "getAssignmentsByConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite storage configuration. To list the storage configurations that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurations` API or run `ibmcloud sat storage config ls`.", "name": "config", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Assignments are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" }, "minItems": 0, "maxItems": 100 }, "example": [ { "channelName": "my-cluster", "channelUuid": "example-id-123", "cluster": "example-value", "clusterName": "my-cluster", "configRevisionStatus": { "isRevisionUpdateAvailable": false, "latestRevision": "example-value", "revision": "example-value" }, "created": "example-value", "groups": [ "example-value" ], "isAssignmentUpgradeAvailable": false } ] } } }, "400": { "description": "Bad Request. Either the config is missing or the specified config is invalid. To list the storage configurations that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurations` API or run `ibmcloud sat storage config ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified config could not be found. To list the storage configurations that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurations` API or run `ibmcloud sat storage config ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An assignment is retrieved by using the associated configuration.", "events": [ { "name": "satellite.subscription.get-by-config" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-organization.read" } ], "description": "To get the action, the user must have the Satellite Config Organization Read access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAssignmentsByConfig?config=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAssignmentsByController": { "get": { "description": "List storage assignments that you have access to in a Satellite location. Returned details include the assignment name, UUID, and creation timestamp.", "tags": [ "storage", "satellite" ], "summary": "List storage assignments in a Satellite location.", "operationId": "getAssignmentsByController", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location to list assignments for. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Assignments are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" }, "minItems": 0, "maxItems": 100 }, "example": [ { "channelName": "my-cluster", "channelUuid": "example-id-123", "cluster": "example-value", "clusterName": "my-cluster", "configRevisionStatus": { "isRevisionUpdateAvailable": false, "latestRevision": "example-value", "revision": "example-value" }, "created": "example-value", "groups": [ "example-value" ], "isAssignmentUpgradeAvailable": false } ] } } }, "400": { "description": "Bad Request. The controller is missing. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified location could not be found. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A list of assignments is retrieved by using a location.", "events": [ { "name": "satellite.subscription.get-by-controller" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.read" } ], "description": "To get the action, the user must have the Satellite Config Subscription Read access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAssignmentsByController?controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getAvailableStorageClasses": { "get": { "description": "List and filter the available storage classes from assigned Satellite storage configurations on a Satellite or service cluster.\nBy default, only the available storage classes from Software Defined Storage (SDS) template based Satellite storage configurations are returned. To view all available storage classes, set the `onlyShowSDS` query paramter flag to `false`.\nOptionally, filter the available storage classes based on volume type using the `volumeType` query parameter.\n\nNote that, if a volume type is specified, the most preferable storage class from each of the assigned storage configurations of specified volume type is returned. For user-defined storage classes, the preference is set while creating the storage configuration. To view the preference for all the storage classes of an assigned storage configuration, run `ibmcloud sat storage config class ls --config CONFIG --show-params` and look for the parameter `storage-class-preference`.", "tags": [ "storage", "satellite" ], "summary": "List and filter available storage classes from assigned Satellite storage con...", "operationId": "getAvailableStorageClasses", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the Satellite cluster or service cluster for which available storage classes from assigned Satellite storage configurations are to be listed. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location that the cluster is registered to. To list the Satellite clusters you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Filter the available storage classes by volume type. The supported volume types are `file`, `block` and `object`. If unspecified, available storage classes of all volume types are returned.", "name": "volume_type", "in": "query", "schema": { "type": "string" } }, { "description": "Specify `true` or `false` to view only the available storage classes from software-defined storage (SDS) storage configurations. If unspecified, the default value is `true`.", "name": "only_show_sds", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK. Available storage classes are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableStorageClasses" }, "example": { "storage-classes": [ "example-value" ] } } } }, "400": { "description": "Bad Request. The request failed due to one of the following reasons:\n1. The cluster is missing or the specified cluster is invalid. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.\n2. The specified cluster is neither a Satellite cluster nor a service cluster. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`.\n3. The specified value is an invalid value for parameter `volumeType`. Supported values for `volumeType` parameter are: `file, block, object`.\n4. The specified value is an invalid value for parameter `onlyShowSDS`. Supported values for `onlyShowSDS` parameter are: `true, false`.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or location could not be found. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud ks cluster ls --provider=satellite`. To list the service clusters for a location that you have access to, run `ibmcloud sat services --location LOCATION`. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A list of available storage classes for an assignment is retrieved.", "events": [ { "name": "satellite.available.classes.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" }, { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Read Satellite Location access or the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getAvailableStorageClasses?cluster=example-value&controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getDesiredStorageConfig": { "get": { "description": "List the storage requests for a cluster in a Satellite location.", "tags": [ "storage", "satellite" ], "summary": "List Storage requests on a cluster.", "operationId": "getDesiredStorageConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the cluster where you want to list storage requests. To list the Satellite clusters you have access to, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`.\nThe response body for each storage request contains the request specifications and the following fields:\n 1. The`assignment` field. This field is initially empty when the storage request is created. When the location administrator assigns a storage configuration to the cluster that matches the storage request, this field is populated with the UUID of the assignment.\n 2. A `status` field in the `config` section that indicates the status of storage provisioning or assignment. If a storage assignment is created but no action is taken on it, the status is set to `pending`. If a storage configuration has been assigned to the cluster, the status is set to `assigned`. If the storage request is deleted, the status is set to `deleted`.\n 3. A `status` field in the `backend` section. This field indicates whether the location administrator has acknowledged the request to increase storage capacity. If the storage capacity expansion request is not acknowledged, the status is set to `pending`. If the request is acknowledged by the location administrator, the status is set to `completed`.\n", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location that the cluster is registered to. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK. Storage requests are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetDesiredStorageConfigResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "cluster": "example-value", "storage-requests": [ { "assignment": "example-value", "backend": { "attribute": { "max-volume-size": "example-value", "total-capacity": "example-value" }, "status": "example-value" }, "config": { "attribute": { "offering-type": "example-value", "provider": "vpc-gen2", "storageclasses": [ "example-value" ], "supported-ocp-versions": "1.28.5", "volume-availability": "example-value", "volume-encryption-at-rest": "example-value", "volume-expansion": "example-value", "volume-snapshot": "example-value" }, "status": "example-value" }, "request-id": "example-id-123" } ] } ] } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Could not list the IBM Cloud Satellite storage requests. Verify the input parameters and retry the request. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A desired storage configuration is returned.", "events": [ { "name": "satellite.storage-configuration.get-desired" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" }, { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Read Satellite Location access or the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getDesiredStorageConfig?cluster=example-value&controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getStorageConfiguration": { "get": { "description": "View the details of a Satellite storage configuration.", "tags": [ "storage", "satellite" ], "summary": "View details of a Satellite storage configuration.", "operationId": "getStorageConfiguration", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name of the storage configuration. To list the storage configurations that you have access to, run `ibmcloud sat storage config ls`.", "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Specify `true` to include details of assignment(s) of the specified storage configuration. The default value is `false`.", "name": "include-assignments", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "201": { "description": "OK. Storage configuration details are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageConfig" }, "example": { "config-name": "my-cluster", "config-version": "1.28.5", "controller": "example-value", "created": "example-value", "is-revision-update-available": false, "is-user-secret-parameters-set": {}, "latest-revision": "example-value", "location": "us-south" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage configuration is retrieved.", "events": [ { "name": "satellite.storage-configuration.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-organization.read" } ], "description": "To get the action, the user must have the Satellite Config Organization Read access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getStorageConfiguration?name=my-cluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getStorageConfigurations": { "get": { "description": "List the Satellite storage configurations that you have access to in a Satellite location or in the IBM Cloud account.", "tags": [ "storage", "satellite" ], "summary": "List Satellite storage configurations.", "operationId": "getStorageConfigurations", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location to list storage configurations for. If no location is specified, all storage configurations that you have access to in the IBM Cloud account are returned. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "name": "location", "in": "query", "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK. Storage configurations are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListStorageConfigData" }, "minItems": 0, "maxItems": 100 }, "example": [ { "config-name": "my-cluster", "config-version": "1.28.5", "controller": "example-value", "created": "example-value", "is-revision-update-available": false, "latest-revision": "example-value", "location": "us-south", "revision": "example-value" } ] } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getStorageConfigurations\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getStorageConfigurationsByController": { "get": { "description": "List the Satellite storage configurations that you have access to in a Satellite location.", "tags": [ "storage", "satellite" ], "summary": "List Satellite storage configurations in a Satellite location.", "operationId": "getStorageConfigurationsByController", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location to list storage configurations for. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK. Storage configurations are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListStorageConfigData" }, "minItems": 0, "maxItems": 100 }, "example": [ { "config-name": "my-cluster", "config-version": "1.28.5", "controller": "example-value", "created": "example-value", "is-revision-update-available": false, "latest-revision": "example-value", "location": "us-south", "revision": "example-value" } ] } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A list of storage configurations is retrieved by using a location.", "events": [ { "name": "satellite.storage-configuration.get-by-controller" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-organization.read" } ], "description": "To get the action, the user must have the Satellite Config Organization Read access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getStorageConfigurationsByController?controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getStorageTemplate": { "get": { "description": "View the details of a Satellite storage template by name and version", "tags": [ "storage", "satellite" ], "summary": "View the details of a Satellite storage template.", "operationId": "getStorageTemplate", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name of the storage template. To list the storage templates that you have access to, use the `GET /v2/storage/satellite/getStorageTemplates` API or run `ibmcloud sat storage template ls`.", "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The version of the storage template. To list the storage templates that you have access to, use the `GET /v2/storage/satellite/getStorageTemplates` API or run `ibmcloud sat storage template ls`.", "name": "version", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Storage template details are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisteredStorageVersion" }, "example": { "custom-parameters": [ { "Validator": {}, "category": "example-value", "default": "example-value", "description": "example-value", "displayname": "my-cluster", "max-length": 1, "min-length": 1, "mutable": "example-value" } ], "description": "example-value", "name": "my-cluster", "revision": "example-value", "status": "example-value", "storage-class-parameters": [ { "Validator": {}, "category": "example-value", "default": "example-value", "description": "example-value", "displayname": "my-cluster", "max-length": 1, "min-length": 1, "mutable": "example-value" } ], "storage-class-template": "example-value", "tags": [ { "name": "my-cluster", "value": "example-value", "valueFrom": { "configMapKeyRef": { "key": "example-value", "name": "my-cluster", "optional": false }, "fieldRef": { "apiVersion": "1.28.5", "fieldPath": "example-value" }, "fileKeyRef": { "key": "example-value", "optional": false, "path": "example-value", "volumeName": "my-cluster" }, "resourceFieldRef": { "containerName": "my-cluster", "divisor": {}, "resource": "example-value" }, "secretKeyRef": { "key": "example-value", "name": "my-cluster", "optional": false } } } ] } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. User is not allowed to use the specified version of the storage template. To list the storage templates that you have access to, use the `GET /v2/storage/satellite/getStorageTemplates` API or run `ibmcloud sat storage template ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified storage template name or version could not be found. To list the storage templates that you have access to, use the `GET /v2/storage/satellite/getStorageTemplates` API or run `ibmcloud sat storage template ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "410": { "description": "The specified version of the storage template is unsupported. To list the storage templates that you have access to, use the `GET /v2/storage/satellite/getStorageTemplates` API or run `ibmcloud sat storage template ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage template is retrieved.", "events": [ { "name": "satellite.storage-template.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" } ], "description": "To get the action, the user must have the Read Satellite Location access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getStorageTemplate?name=my-cluster&version=1.28.5\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getStorageTemplateChangelog": { "get": { "description": "View the change log details of all Satellite storage templates or a specific Satellite storage template by name.", "tags": [ "storage", "satellite" ], "summary": "View the change log details of Satellite storage templates.", "operationId": "getStorageTemplateChangelog", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name of the storage template that you want to get the change log for. To list the storage templates that you have access to, use the `GET /v2/storage/satellite/getStorageTemplates` API or run `ibmcloud sat storage template ls`. To get change logs for all storage templates that you have access to, skip this parameter.", "name": "name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Change log(s) of the storage template(s) is/are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevisionLogForVersionResp" }, "example": { "latest-revision": { "cves": "example-value", "fixes": [ "example-value" ], "golang": "example-value", "new-features": [ "example-value" ], "release-date": "example-value", "revision": "example-value", "ubi": "example-value" }, "previous-revision": { "cves": "example-value", "fixes": [ "example-value" ], "golang": "example-value", "new-features": [ "example-value" ], "release-date": "example-value", "revision": "example-value", "ubi": "example-value" }, "status": "example-value" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified storage template could not be found. To list the storage templates that you have access to, use the `GET /v2/storage/satellite/getStorageTemplates` API or run `ibmcloud sat storage template ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Failed to fetch the changelog for the storage template. Note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage template's changelog is retrieved.", "events": [ { "name": "satellite.storage-template.get-changelog" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" } ], "description": "To get the action, the user must have the Read Satellite Location access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getStorageTemplateChangelog\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/getStorageTemplates": { "get": { "description": "List Satellite storage templates.", "tags": [ "storage", "satellite" ], "summary": "List Satellite storage templates.", "operationId": "getStorageTemplates", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Storage templates are listed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredStorage" }, "minItems": 0, "maxItems": 100 }, "example": [ { "default-version": "1.28.5", "description": "example-value", "displayname": "my-cluster", "enabled": "example-value", "name": "my-cluster", "provider": "vpc-gen2", "versions": [ { "custom-parameters": [ { "Validator": {}, "category": "example-value", "default": "example-value", "description": "example-value", "displayname": "my-cluster", "max-length": 1, "min-length": 1, "mutable": "example-value" } ], "description": "example-value", "name": "my-cluster", "revision": "example-value", "status": "example-value", "storage-class-parameters": [ { "Validator": {}, "category": "example-value", "default": "example-value", "description": "example-value", "displayname": "my-cluster", "max-length": 1, "min-length": 1, "mutable": "example-value" } ], "storage-class-template": "example-value", "tags": [ { "name": "my-cluster", "value": "example-value", "valueFrom": { "configMapKeyRef": { "key": "example-value", "name": "my-cluster", "optional": false }, "fieldRef": { "apiVersion": "1.28.5", "fieldPath": "example-value" }, "fileKeyRef": { "key": "example-value", "optional": false, "path": "example-value", "volumeName": "my-cluster" }, "resourceFieldRef": { "containerName": "my-cluster", "divisor": {}, "resource": "example-value" }, "secretKeyRef": { "key": "example-value", "name": "my-cluster", "optional": false } } } ] } ] } ] } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A list of storage templates is retrieved.", "events": [ { "name": "satellite.storage-template.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.location.read" } ], "description": "To get the action, the user must have the Read Satellite Location access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/storage/satellite/getStorageTemplates\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/removeAssignment": { "delete": { "description": "Remove an assignment with a given UUID.", "tags": [ "storage", "satellite" ], "summary": "Remove an assignment.", "operationId": "removeAssignment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "ID of the assignment. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "name": "uuid", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location. To list the Satellite locations that you have access to, use the `GET /v2/satellite/getControllers` API or run `ibmcloud sat location ls`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. The assignment is removed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveSubscriptionData" }, "example": { "removeSubscription": { "success": false, "uuid": "example-id-123" } } } } }, "400": { "description": "Bad Request. Either the uuid is missing or the specified uuid is invalid. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified assignment could not be found. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An assignment is deleted.", "events": [ { "name": "satellite.subscription.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.delete" } ], "description": "To get the action, the user must have the Satellite Config Subscription Delete access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v2/storage/satellite/removeAssignment?uuid=example-id-123&controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/removeDesiredStorageConfig": { "delete": { "description": "Delete a storage request on a cluster. If the cluster assignment status of a storage request is `pending` when this API is called, the request is deleted from the database. If the storage request is assigned to a cluster, the request is marked as `deleted` but not removed from the database.\nTo check the cluster assignment status of a storage request, see the `status` field in the `config` section of the`/v2/satellite/getDesiredStorageConfig` API response.", "tags": [ "storage", "satellite" ], "summary": "Delete a storage request", "operationId": "removeDesiredStorageConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the storage request. To list storage requests, use the `/v2/satellite/getDesiredStorageConfig` API.", "name": "request-id", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the cluster (`cluster`) on which the storage request is placed on.\nTo list storage requests, use the `/v2/satellite/getDesiredStorageConfig` API.\nTo list the Satellite clusters you have access to, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`.\n", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "OK. The storage configuration is removed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "example-value", "description": "example-value", "incidentID": "example-id-123", "recoveryCLI": "example-value", "terseDescription": "example-value", "type": "example-value" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage request is deleted.", "events": [ { "name": "satellite.storage-configuration.delete-desired" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v2/storage/satellite/removeDesiredStorageConfig?request-id=example-id-123&cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/removeStorageConfiguration": { "delete": { "description": "Remove a Satellite storage configuration with a given UUID.\nIf you want to remove a Satellite storage configuration that is currently used in a Satellite storage assignment, set the `removeAssignments` query paramter flag to `true`. This flag when set to `true` removes the storage configuration as well as any associated assignments.", "tags": [ "storage", "satellite" ], "summary": "Remove a Satellite storage configuration.", "operationId": "removeStorageConfiguration", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The UUID of the storage configuration. To list the storage configurations that you have access to, run `ibmcloud sat storage config ls`. To view the storage assignments associated with a given storage configuration and the storage configuration UUID, run `ibmcloud sat config get --config=`.", "name": "uuid", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location. To list the Satellite locations that you have access to, use the `GET /v2/satellite/getControllers` API or run `ibmcloud sat location ls`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Specify `true` to remove the storage configuration along with the associated assignments. If unspecified, the default value is `false`.", "name": "remove_assignments", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK. The storage configuration is removed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage configuration is deleted.", "events": [ { "name": "satellite.storage-configuration.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-configuration.update" } ], "description": "To get the action, the user must have the Satellite Config Configuration Update access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \"/global/v2/storage/satellite/removeStorageConfiguration?uuid=example-id-123&controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/storage/satellite/setAssignmentAutoupgrade": { "patch": { "description": "Enable or disable automatic upgrades for an existing assignment(s) of a given storage configuration. To enable automatic upgrades, specify `autoUpgrade=true`. The default value is `false`. You can enable automatic upgrades for all assignments by specifying `All=true`. Alternatively, you can specify one or more individual assignment `UUIDs` to upgrade specific assignments.", "tags": [ "storage", "satellite" ], "summary": "Enable or disable automatic upgrades for an existing storage assignment(s).", "operationId": "setAssignmentAutoupgrade", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAssignmentAutoupgradeInputData" } } }, "description": "The parameters must include:\n 1. Storage configuration name or ID (`config`).\n 2. Satellite Location (`controller`).\n 3. Set the `autoUpgrade` flag to `true` to enable assignments for automatic upgrades. If unspecified, it is assumed to be `false`.\n 4. Either set `All` to enable/disable automatic upgrades for all the assignments of the storage configuration or provide the `UUIDs` to enable/disable automatic upgrades for a set of assignments.\n", "required": true }, "x-codegen-request-body-name": "assignment-params", "responses": { "200": { "description": "OK. The assignment(s) is/are enabled/disabled for automatic upgrades.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAssignmentAutoupgradeInputData" }, "example": { "assignment": { "all": false, "uuids": [ "example-id-123" ] }, "autoUpgrade": false, "config": "example-value", "controller": "example-value" } } } }, "400": { "description": "Bad Request. The request failed due to one of the following reasons:\n1. The config name/uuid is missing or the specified config is invalid. To list the storage configurations that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurations` API or run `ibmcloud sat storage config ls`.\n2. Both the parameters `All` and `UUIDs` are provided. Both cannot be provided at the same time.\n3. No assignment(s) provided to enable/disable automatic upgrade. Neither of the parameters `All` and `UUIDs` are provided.\n4. The assignment uuid provided in `UUIDs` parameter is invalid. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignmentsByConfig` API or run `ibmcloud sat storage assignment ls --config config`.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The request failed due to one of the following reasons:\n1. The specified config could not be found. To list the storage configurations that you have access to, use the `GET /v2/storage/satellite/getStorageConfigurations` API or run `ibmcloud sat storage config ls`.\n2. The specified assignment could not be found. To list the storage assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An assignment is updated.", "events": [ { "name": "satellite.subscription.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.update" } ], "description": "To get the action, the user must have the Satellite Config Subscription Update access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v2/storage/satellite/setAssignmentAutoupgrade\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"assignment\": {\n", " \"all\": false,\n", " \"uuids\": [\n", " \"example-id-123\"\n", " ]\n", " },\n", " \"autoUpgrade\": false,\n", " \"config\": \"example-value\",\n", " \"controller\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/setDesiredStorageConfig": { "post": { "description": "Create a storage request for a cluster by providing the cluster ID and the required storage specifications. You can only create storage requests for the clusters you have access to.", "tags": [ "storage", "satellite" ], "summary": "Create a storage request on a cluster", "operationId": "setDesiredStorageConfig", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDesiredStorageConfigRequest" } } }, "description": "The configuration details for your Satellite storage request. Include the cluster ID (`cluster`) and the required storage specifications. To list available clusters in the Satellite location, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`. The following storage specifications are supported:\n 1. Required:\n a. Volume type. Specify one of `file`, `block` or `object`.\n b. Provider. Specify one of the supported providers of storage templates. For a list of supported providers or templates, see `https://github.com/IBM/ibm-satellite-storage/blob/develop/config-templates/template_list.json`.\n c. Maximum volume size and total capacity. Specify a positive integer value. Use `K` for kilobytes, `M` for megabytes, `G` for gigabytes, `T` for terabytes, or `E` for exabytes. Example: `100G`.\n 2. Optional parameters.\n a. Offering type. Specify either `sds` for software-defined storage or `non-sds`.\n b. Volume encryption at rest. This is a boolean value. Specify `true` or `false`.\n c. Volume availability. This is a boolean value. Specify `true` or `false`.\n d. Volume expansion. This is a boolean value. Specify `true` or `false`.\n e. Volume snapshot. This is a boolean value. Specify `true` or `false`.\n f. Storage classes. Include a list of specific storage classes. Note that currently, requested storage classes are not strictly validated while provisioning storage.\n\nSee the following example payload for a storage request that specifies the cluster ID, volume type, offering type, provider, volume availability, volume expansion, volume snap shot, and storage classes: `{\"cluster\": \"c9l508rw0eo68tnbijrg\",\"storage-requests\": {\"volume-type\": \"file\",\"offering-type\": \"sds\",\"provider\": \"redhat\",\"volume-availability\": \"regional\",\"volume-expansion\": \"true\",\"volume-encryption-at-rest\": \"true\",\"storageclasses\": [\"gold\"],\"volume-snapshot\": \"false\",\"max-volume-size\": \"100G\",\"total-capacity\": \"1T\"}}`\n", "required": true }, "x-codegen-request-body-name": "satellite-storage-request", "responses": { "201": { "description": "OK. The storage request is created.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Could not find the IBM Cloud Satellite cluster, volume type, available volume, or storage class. Verify the input parameters and try again. To list the Satellite clusters that you have access to and their respective location name or ID, use the `GET /v2/satellite/getClusters` API or run `ibmcloud sat service ls --location=`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A desired storage configuration request is created.", "events": [ { "name": "satellite.storage-configuration.set-desired" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/satellite/setDesiredStorageConfig\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"storage-requests\": {\n", " \"max-volume-size\": \"example-value\",\n", " \"offering-type\": \"example-value\",\n", " \"provider\": \"vpc-gen2\",\n", " \"storageclasses\": [\n", " \"example-value\"\n", " ],\n", " \"total-capacity\": \"example-value\",\n", " \"volume-availability\": \"example-value\",\n", " \"volume-encryption-at-rest\": \"example-value\",\n", " \"volume-expansion\": \"example-value\"\n", " }\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/updateAssignment": { "patch": { "description": "Update the details of an assignment, such as the name of the assignment, the storage configuration version that it uses, or the cluster group(s) on which you want to apply the configuration. For updating an assignment to the latest available storage configuration version, set the `updateConfigVersion` flag to `true`. If unspecified, it is assumed to be `false`.", "tags": [ "storage", "satellite" ], "summary": "Update an assignment.", "operationId": "updateAssignment", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionInputData" } } }, "description": "The parameters must include the UUID of the assignment (`uuid`) along with at least one of the following parameters to be updated:\n 1. One or more cluster groups (`groups`) on which you want to apply the configuration. To list the cluster groups that you have access to, run `ibmcloud sat group ls`.\n 2. New name of the assignment (`name`).\n 3. set the `updateConfigVersion` flag to `true` for updating an assignment to the latest available storage configuration version. If unspecified, it is assumed to be `false`. To see if assignment upgrade is available, use the `GET /v2/storage/satellite/getAssignment` API and look for `isAssignmentUpgradeAvailable` field in response or run `ibmcloud sat storage assignment get --assignment UUID` and look for `Assignment Upgrade Available` field in response.\n", "required": true }, "x-codegen-request-body-name": "assignment-params", "responses": { "200": { "description": "OK. The assignment is updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionData" }, "example": { "editSubscription": { "success": false, "uuid": "example-id-123" } } } } }, "400": { "description": "Bad Request. The request failed due to one of the following reasons:\n1. The uuid is missing or the specified uuid is invalid. To list the assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`.\n2. There is no parameter in the request body to update. Input at least one parameter to be updated.\n3. Storage assignment is already up to date with the latest available storage configuration version. Set the `updateConfigVersion` flag to `false` if you want to update at least assignment name or cluster group(s) on which you want to apply the configuration.\n4. Updating an assignment, created for a cluster, to cluster group(s) is not supported. Run `ibmcloud sat storage assignment rm` to remove the assignment and create new assignment with cluster group(s).\n", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified assignment or cluster group(s) could not be found. To list the storage assignments that you have access to, use the `GET /v2/storage/satellite/getAssignments` API or run `ibmcloud sat storage assignment ls`. To list the Satellite cluster groups you have access to, run `ibmcloud sat group ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "An assignment is updated.", "events": [ { "name": "satellite.subscription.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-subscription.update" } ], "description": "To get the action, the user must have the Satellite Config Subscription Update access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v2/storage/satellite/updateAssignment\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"groups\": [\n", " \"example-value\"\n", " ],\n", " \"name\": \"my-cluster\",\n", " \"updateConfigVersion\": false,\n", " \"uuid\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/updateStorageConfiguration": { "post": { "description": "Update an existing Satellite storage configuration. Note that you cannot update Satellite storage configurations that are currently used in a Satellite storage assignment.", "tags": [ "storage", "satellite" ], "summary": "Deprecated. To update a Satellite storage configuration, you can use /v2/stor...", "operationId": "updateStorageConfiguration", "deprecated": true, "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageConfigUpdateInput" } } }, "description": "Include the storage template name (`storage-template-name`) and version (`storage-template-version`), the name of the existing storage configuration (`config-name`), the required parameters for the specified template (`user-config-parameters`, `user-secret-parameters`, and `storage-class-parameters`) and the Satellite location (`location`) where you want to use the storage configuration. To list the storage configurations that you have access to, run `ibmcloud sat storage config ls`. To view the storage assignments associated with a given storage configuration, run `ibmcloud sat config get --config=`. To list the storage templates and template versions, run `ibmcloud sat storage template ls`. To list the parameters for a given storage template and template version, run `ibmcloud sat storage template get --name= --version=`. To list the Satellite locations that you have access to, run `ibmcloud sat location ls`.", "required": true }, "x-codegen-request-body-name": "storageConfigUpdateInput", "responses": { "201": { "description": "OK. The storage configuration is updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "example-value", "description": "example-value", "incidentID": "example-id-123", "recoveryCLI": "example-value", "terseDescription": "example-value", "type": "example-value" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/satellite/updateStorageConfiguration\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"config-name\": \"my-cluster\",\n", " \"controller\": \"example-value\",\n", " \"storage-class-parameters\": [\n", " {}\n", " ],\n", " \"update-assignments\": false,\n", " \"user-config-parameters\": {},\n", " \"user-secret-parameters\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/updateStorageConfigurationByController": { "post": { "description": "Update an existing Satellite storage configuration. If a Satellite storage configuration is already assigned, only the parameters that are marked as `mutable` can be updated.", "tags": [ "storage", "satellite" ], "summary": "Update a Satellite storage configuration.", "operationId": "updateStorageConfigurationByController", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageConfigUpdateInput" } } }, "description": "Include the name of the storage configuration (`config-name`) and the name or ID of the relevant Satellite location (`controller`). To apply the updated storage configuration to this storage configuration's existing assignments, set the `update-assignments` option to `true`. If left unspecified, the `update-assignments` option defaults to `false`.\n\nIf the storage configuration is assigned, only the configuration (`user-config-parameters`) and secret (`user-secret-parameters`) parameters that are marked as `mutable` can be updated. If the storage configuration is not assigned, all parameters can be updated.\n\nIf user-defined storage classes are supported, specify the required storage class parameters (`storage-class-parameters`) for the template that the storage configuration was created from. Note that any existing user-defined storage classes are overwritten by any storage classes specified in this API request's payload. For example, if you intend to define new storage classes and keep the existing storage classes, you must specify the parameters for both the existing and new user-defined storage classes.\n\nTo list the storage configurations that you have access to, run `ibmcloud sat storage config ls`.\nTo view the storage assignments associated with a given storage configuration, run `ibmcloud sat config get --config=`.\nTo list the parameters for a given storage template and template version, run `ibmcloud sat storage template get --name= --version=`.\nTo list the parameters of existing storage classes, run `ibmcloud sat storage config class ls --config= --show-params`.\nTo list the Satellite locations that you have access to, run `ibmcloud sat location ls`.\n", "required": true }, "x-codegen-request-body-name": "storageConfigUpdateInput", "responses": { "201": { "description": "OK. The storage configuration is updated.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "example-value", "description": "example-value", "incidentID": "example-id-123", "recoveryCLI": "example-value", "terseDescription": "example-value", "type": "example-value" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage configuration is updated.", "events": [ { "name": "satellite.storage-configuration.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-configuration.update" } ], "description": "To get the action, the user must have the Satellite Config Configuration Update access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/storage/satellite/updateStorageConfigurationByController\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"config-name\": \"my-cluster\",\n", " \"controller\": \"example-value\",\n", " \"storage-class-parameters\": [\n", " {}\n", " ],\n", " \"update-assignments\": false,\n", " \"user-config-parameters\": {},\n", " \"user-secret-parameters\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/storage/satellite/updateStorageConfigurationRevision": { "patch": { "description": "Update a Satellite storage configuration to use the latest template revision and optionally update assignment(s) based on the specified storage configuration. To check if a new template revision is available, view the 'getStorageConfiguration' API response for the storage configuration you want to update and compare your current template revision (`revision`) with the latest template revision (`latest-revision`). To update assignment(s) of the specified storage configuration, set the update assignments (`updateAssignments`) flag to `true`. By default, the flag is set to `false` if not specified and, assignment(s) are not updated as part of the template revision update operation.", "tags": [ "storage", "satellite" ], "summary": "Update a Satellite storage configuration to use the latest template revision.", "operationId": "updateStorageConfigurationRevision", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The name or UUID of the storage configuration. To list the storage configurations that you have access to, run `ibmcloud sat storage config ls`.", "name": "config", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name or ID of the Satellite location. To list the Satellite locations that you have access to, use the `GET /v2/satellite/getControllers` API or run `ibmcloud sat location ls`.", "name": "controller", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Specify `true` or `false` to update assignment(s) of the specified storage configuration. The default value is `false`.", "name": "update_assignments", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "201": { "description": "OK. Updated storage configuration template to latest revision.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "example-value", "description": "example-value", "incidentID": "example-id-123", "recoveryCLI": "example-value", "terseDescription": "example-value", "type": "example-value" } } } }, "401": { "description": "Unauthorized. Your IAM token could not be verified. Make sure that you are logged in to IBM Cloud, and then run `ibmcloud iam oauth-tokens` to retrieve your access tokens.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "406": { "description": "Storage configuration template is already up to date with the latest revision.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A storage configuration is updated to the latest revision.", "events": [ { "name": "satellite.storage-configuration.update-revision" } ] }, "x-ibm-permissions": { "actions": [ { "name": "satellite.config-configuration.update" } ], "description": "To get the action, the user must have the Satellite Config Configuration Update access in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PATCH \"/global/v2/storage/satellite/updateStorageConfigurationRevision?config=example-value&controller=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/updateMaster": { "post": { "description": "Update the Kubernetes master to the default API version. During the update, you cannot access or change the cluster. Worker nodes, apps, and resources that have been deployed by the user are not modified and will continue to run. You might need to change your YAML files for future deployments. For details, see the release notes at https://cloud.ibm.com/docs/containers?topic=containers-cs_versions", "tags": [ "beta" ], "summary": "Update the version of the Kubernetes cluster master node.", "operationId": "v2UpdateMaster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMaster" } } }, "description": "Input parameters to specify the name or ID of the cluster, what version to update the master to, and whether to force the update. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "required": true }, "x-codegen-request-body-name": "UpdateMaster", "responses": { "204": { "description": "Ok. The request to update your master node was successfully processed.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The cluster cannot be updated. The master is more than two versions behind the targeted version, which is not supported. Instead, update to a supported version two or less ahead of the current version, or create a new cluster at the targeted version.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The specified value is already set on the cluster. To list the clusters properties, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A cluster master update is requested.", "events": [ { "name": "containers-kubernetes.cluster-master.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/updateMaster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"force\": false,\n", " \"version\": \"1.28.5\"\n", "}'\n" ] } ] } ] } } } }, "/v2/vpc/createCluster": { "post": { "description": "Create a cluster in a Virtual Private Cloud (VPC) that you have access to.\nNote: This API method requires Administrator platform role for IBM Cloud Kubernetes Service at the account level, as well as access to several other services such as the underlying infrastructure provider. For more information, see 'https://ibm.biz/cluster-perms'.", "tags": [ "v2" ], "summary": "Create a VPC cluster.", "operationId": "vpcCreateCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to create the cluster in. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, the cluster is created in the default resource group. After you create a cluster, you cannot change the resource group. Note that if you plan to integrate IBM Cloud services with the cluster, all the resources must be in the same group.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPCCreateCluster" } } }, "description": "Input parameter to add a cluster. For more information, see https://ibm.biz/cluster_create_docs", "required": true }, "x-codegen-request-body-name": "clusterConfig", "responses": { "201": { "description": "Created. The cluster was successfully created in the IBM Cloud account that you are logged in to.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClusterResponse" }, "example": { "clusterID": "example-id-123", "messages": [ { "level": "example-value", "text": "example-value" } ], "non_critical_errors": { "incidentID": "example-id-123", "items": [ { "code": "example-value", "description": "example-value", "recoveryCLI": "example-value", "terseDescription": "example-value", "type": "example-value" } ] } } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified VPC infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict. A cluster with the same name already exists. Choose another name for your cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The creation of a cluster is requested.", "events": [ { "name": "containers-kubernetes.cluster.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.create" } ], "description": "To get the action, the user must have the Administrator platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/vpc/createCluster\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cosInstanceCRN\": \"example-value\",\n", " \"cseACLEnabled\": true,\n", " \"defaultWorkerPoolEntitlement\": \"example-value\",\n", " \"disableOutboundTrafficProtection\": false,\n", " \"disablePublicServiceEndpoint\": false,\n", " \"infrastructureTopology\": \"public\",\n", " \"kubeVersion\": \"1.28.5\",\n", " \"name\": \"my-cluster\"\n", "}'\n" ] } ] } ] } } } }, "/v2/vpc/createWorkerPool": { "post": { "description": "Create a worker pool for the specified VPC cluster. Creating a worker pool requires Operator access to Kubernetes Service in the IBM Cloud account.", "tags": [ "v2" ], "summary": "Create a worker pool for a VPC cluster.", "operationId": "vpcCreateWorkerPool", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2VPCCreateWorkerPoolRequest" } } }, "description": "The", "required": true }, "x-codegen-request-body-name": "workerPoolConfig", "responses": { "201": { "description": "Created. The worker pool was successfully created in for the specified cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkerpoolResponse" }, "example": { "workerPoolID": "example-id-123" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "409": { "description": "Conflict. A worker pool create may already be in progress for the provided cluster. Please wait a few minutes and try again.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker pool is created in the cluster.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/vpc/createWorkerPool\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"Zones\": [\n", " {\n", " \"id\": \"example-id-123\",\n", " \"subnetID\": \"10.240.0.0/24\"\n", " }\n", " ],\n", " \"cluster\": \"example-value\",\n", " \"diskEncryption\": false,\n", " \"entitlement\": \"example-value\",\n", " \"flavor\": \"example-value\",\n", " \"hostPool\": \"example-value\",\n", " \"isolation\": \"example-value\",\n", " \"labels\": {}\n", "}'\n" ] } ] } ] } } } }, "/v2/vpc/createWorkerPoolZone": { "post": { "description": "Create a zone in the specified worker pool for a VPC cluster. Workers will be provisioned in each provided zone based on the size of the pool.", "tags": [ "v2" ], "summary": "Create a zone in the specified worker pool for a VPC cluster.", "operationId": "vpcCreateWorkerPoolZone", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to create the cluster in. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, the cluster is created in the default resource group. After you create a cluster, you cannot change the resource group. Note that if you plan to integrate IBM Cloud services with the cluster, all the resources must be in the same group.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkerpoolZoneRequest" } } }, "description": "Input parameters to add zones to the worker pool.", "required": true }, "x-codegen-request-body-name": "workerZoneConfig", "responses": { "201": { "description": "OK. The requested zone has been added to the worker pool.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "400": { "description": "Bad request. The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request in JSON format.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified worker pool could not be found. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls mycluster`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "409": { "description": "Conflict. The provided zone already exists in the worker pool.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and your cluster ID, and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A zone is added to a worker pool.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool-zone.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/vpc/createWorkerPoolZone\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"id\": \"example-id-123\",\n", " \"subnetID\": \"10.240.0.0/24\",\n", " \"workerpool\": \"example-value\"\n", "}'\n" ] } ] } ] } } } }, "/v2/vpc/getCluster": { "get": { "description": "Get details of a VPC cluster.", "tags": [ "v2" ], "summary": "Get details of a VPC cluster.", "operationId": "vpcGetCluster", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "To view additional cluster resources like addons, VLANs, subnets, and storage, pass `true`.", "name": "show_resources", "in": "query", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. Detailed cluster information.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClusterResponse" }, "example": { "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "createdDate": "example-value", "crn": "example-value", "datacenter": "example-value", "desiredTrustedProfileID": "example-id-123", "disableAutoUpdate": false } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Details for a cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM. For more required permissions to create a cluster, see 'https://cloud.ibm.com/docs/containers?topic=containers-access_reference'." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getCluster?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getClusters": { "get": { "description": "List the VPC clusters that you have access to.", "tags": [ "v2" ], "summary": "List the VPC clusters that you have access to.", "operationId": "vpcGetClusters", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group to list clusters for. To list available resource groups, run `ibmcloud resource groups`. If you don't include this header, all the clusters in the account that you have access to are listed.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "Specify a location to filter clusters for. To see supported locations, use the `GET /v1/locations` API or run `ibmcloud ks locations`.", "name": "location", "in": "query", "schema": { "type": "string" } }, { "description": "The name of the provider to filter the clusters by.", "name": "provider", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success. A list of clusters that you have access to is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetClustersResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "addons": [ { "name": "my-cluster", "version": "1.28.5" } ], "caCertRotationStatus": { "actionCompletedDate": "example-value", "actionTriggerDate": "example-value", "status": "example-value" }, "calicoIPAutodetectionConfig": "example-value", "createdDate": "example-value", "datacenter": "example-value", "desiredTrustedProfileID": "example-id-123", "entitlement": "example-value", "etcdPort": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getClusters\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getSubnets": { "get": { "description": "View details for subnets in a VPC for the given region and provider.", "tags": [ "v2" ], "summary": "View subnets for a given VPC.", "operationId": "getSubnets", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name of the VPC provider.", "name": "provider", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The name of the zone in which to list subnets.", "name": "zone", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the VPC.", "name": "vpc", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of all subnets for the given VPC is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnets" }, "example": [ { "availableIPv4AddressCount": 3, "id": "example-id-123", "ipv4CIDRBlock": "example-id-123", "name": "my-cluster", "publicGatewayID": "example-id-123", "publicGatewayName": "my-cluster", "vpcID": "example-id-123", "vpcName": "my-cluster" } ] } } }, "400": { "description": "Bad Request. The given provider, zone, or VPC is invalid.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified VPC infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The VPC subnets for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-subnet.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getSubnets?provider=vpc-gen2&zone=us-south-1&vpc=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getVPC": { "get": { "description": "View details of a virtual private cloud (VPC).", "tags": [ "v2" ], "summary": "View details of a VPC.", "operationId": "getVPC", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The region of the VPC. To list regions, run `ibmcloud ks regions`.", "name": "X-Region", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Optional, specify a resource group ID to use its API key to list VPCs that the API key of the resource group has access to. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name of the infrastructure provider that the VPC is created in. To list infrastructure providers of a VPC, run `ibmcloud ks vpcs` or use the `GET /v2/vpc/getVPCs` API.", "name": "provider", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the VPC. To list the ID of a VPC, run `ibmcloud ks vpcs` or use the `GET /v2/vpc/getVPCs` API.", "name": "vpc_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK. Details of the specified VPC are returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVPCResponse" }, "example": { "id": "example-id-123", "messages": [ { "level": "example-value", "text": "example-value" } ], "name": "my-cluster", "resourceGroup": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified VPC infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Details for a virtual private cloud (VPC) instance are returned.", "events": [ { "name": "containers-kubernetes.account-vpc.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getVPC?provider=vpc-gen2&vpc_id=example-id-123\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getVPCs": { "get": { "description": "View details for all VPCs in the given provider", "tags": [ "v2" ], "summary": "View VPCs for the given provider.", "operationId": "getVPCs", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "Optional, specify a resource group ID to use its API key to list VPCs that the API key of the resource group has access to. To list available resource group IDs, run `ibmcloud resource groups`.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name of the provider in which to list VPCs.", "name": "provider", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. A list of all VPCs is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualPrivateClouds" }, "example": [ { "id": "example-id-123", "name": "my-cluster", "provider": "vpc-gen2", "resourceGroup": "example-value", "zones": [ "us-south-1" ] } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "403": { "description": "Forbidden. The credentials set for the region and resource group have insufficient permissions for the specified VPC infrastructure provider.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "Virtual private cloud (VPC) instances in the IBM Cloud account are listed.", "events": [ { "name": "containers-kubernetes.account-vpc.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getVPCs?provider=vpc-gen2\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getWorker": { "get": { "description": "View detailed information for a worker node in a VPC cluster.", "tags": [ "v2" ], "summary": "View details of a worker node for VPC cluster.", "operationId": "vpcGetWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker node that you want details for. To list all worker nodes for a cluster, use the `GET /v1/clusters/{idOrName}/workers` API or run `ibmcloud ks worker ls --cluster `.", "name": "worker", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker node is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVPCWorkerResponse" }, "example": { "dedicatedHostId": "example-id-123", "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "health": { "message": "example-value", "state": "example-value" }, "id": "example-id-123", "kubeVersion": { "actual": "example-value", "desired": "example-value", "eos": "example-value", "masterEOS": "example-value", "target": "example-value" }, "lifecycle": { "actualOperatingSystem": "example-value", "actualState": "example-value", "desiredOperatingSystem": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "location": "us-south" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "View details of a worker node in the cluster.", "events": [ { "name": "containers-kubernetes.worker.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getWorker?cluster=example-value&worker=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getWorkerPool": { "get": { "description": "View detailed information for a worker pool in a VPC cluster.", "tags": [ "v2" ], "summary": "View details of a worker pool for a VPC cluster.", "operationId": "vpcGetWorkerPool", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the worker pool that you want details for. To list all worker pools for a cluster, use the `GET /v1/clusters/{idOrName}/workerpools` API or run `ibmcloud ks worker-pool ls --cluster `.", "name": "workerpool", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker pool is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVPCWorkerPoolResponse" }, "example": { "autoscaleEnabled": true, "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "flavorState": "example-value", "hostLabels": {}, "id": "example-id-123", "isBalanced": false, "isolation": "example-value" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The details of a worker pool in the cluster are returned.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.get" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getWorkerPool?cluster=example-value&workerpool=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getWorkerPools": { "get": { "tags": [ "v2" ], "summary": "List the worker pools in a VPC cluster.", "operationId": "vpcGetWorkerPools", "parameters": [ { "description": "If you are using the global endpoint, target the Kubernetes Service region. To list available regions, use the `GET /v1/regions` API or run `ibmcloud ks region ls`.", "name": "X-Region", "in": "header", "schema": { "type": "string" } }, { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Detailed information about the worker pools is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GetVPCWorkerPoolResponse" }, "minItems": 0, "maxItems": 100 }, "example": [ { "autoscaleEnabled": true, "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "flavorState": "example-value", "hostLabels": {}, "id": "example-id-123", "isBalanced": false, "isolation": "example-value" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker pools for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker-pool.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getWorkerPools?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getWorkers": { "get": { "description": "View detailed information for all worker nodes in a VPC cluster.", "tags": [ "v2" ], "summary": "View all workers for VPC cluster.", "operationId": "vpcGetWorkers", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } }, { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "name": "cluster", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "true|false Shows deleted workers", "name": "show_deleted", "in": "query", "schema": { "type": "string" } }, { "description": "The name or ID of the worker pool to filter results for. Run `ibmcloud ks worker-pool ls --cluster `.", "name": "pool", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok. Details for all workers in the VPC cluster.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVPCWorkersResponse" }, "example": [ { "dedicatedHostId": "example-id-123", "dedicatedHostPoolId": "example-id-123", "flavor": "example-value", "health": { "message": "example-value", "state": "example-value" }, "id": "example-id-123", "kubeVersion": { "actual": "example-value", "desired": "example-value", "eos": "example-value", "masterEOS": "example-value", "target": "example-value" }, "lifecycle": { "actualOperatingSystem": "example-value", "actualState": "example-value", "desiredOperatingSystem": "example-value", "desiredState": "example-value", "message": "example-value", "messageDate": "example-value", "messageDetails": "example-value", "messageDetailsDate": "example-value" }, "location": "us-south" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster could not be found. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "The worker nodes for a cluster are listed.", "events": [ { "name": "containers-kubernetes.cluster-worker.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.read" } ], "description": "To get the action, the user must have the Viewer platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getWorkers?cluster=example-value\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/getZones": { "get": { "description": "List available zones that you can use to create a cluster in an IBM Cloud Kubernetes Service region.", "tags": [ "v2" ], "summary": "List available zones in a region.", "operationId": "vpcGetZones", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. Note that some zones are only available to certain accounts. Specify your IAM token to get the full list of zones that are available to your account. If no authorization is specified, then only zones that are generally available are returned. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "schema": { "type": "string" } }, { "description": "The provider for which to list zones. Defaults to vpc-classic.", "name": "provider", "in": "query", "schema": { "type": "string" } }, { "description": "Determines whether to show the flavors for the returned zones.", "name": "show_flavors", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success. A list of available zones for a region is returned.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Zones" }, "example": [ { "flavors": [ { "additionalStorage": [ { "Count": 3, "DeviceType": "example-value", "RAIDConfiguration": "example-id-123", "Size": 3, "name": "my-cluster", "profile": "example-value" } ], "architecture": "example-value", "cores": 1, "deprecated": false, "flavor_class": "example-value", "gpus": [ { "Count": 3, "Type": "example-value" } ], "id": "example-id-123", "memory": "example-value" } ], "id": "example-id-123", "metro": "example-value", "name": "my-cluster" } ] } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "No zones found for provider. Run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "No Activity Tracker event is generated for this operation.", "events": [ {} ] }, "x-ibm-permissions": { "actions": [ {} ], "description": "No IBM Cloud IAM role is required for this operation." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \"/global/v2/vpc/getZones\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\"\n" ] } ] } ] } } } }, "/v2/vpc/replaceWorker": { "post": { "description": "Delete the specified worker node from the cluster and provision a new worker node to replace the deleted worker node. You might replace a worker node if you cannot reload it, such as if it enters a troubled state. You can also replace the worker node to include an update to the same major and minor version of the master. The replacement worker node is created in the same zone, same worker pool, and with the same flavor as the deleted worker node. However, the replacement worker node is assigned a new private IP address, and loses any custom labels that you applied to the old worker node (worker pool labels are still applied to the replacement worker node). Before you replace the worker node, consider adding more worker nodes to the cluster and draining the worker node to help avoid downtime for your apps.", "tags": [ "v2" ], "summary": "Replace a worker node with a new worker node.", "operationId": "vpcReplaceWorker", "parameters": [ { "description": "Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run `ibmcloud iam oauth-tokens`.", "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } }, { "description": "The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the `GET /v1/clusters/idOrName` API.", "name": "X-Auth-Resource-Group", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceWorkerRequest" } } }, "description": "Input parameters to replace a worker node. The cluster and worker node ID parameters are required. The update parameter is optional. To update the worker node to the same major and minor version as the master, set “update” to true.", "required": true }, "x-codegen-request-body-name": "replaceWorkerRequest", "responses": { "204": { "description": "OK. The worker node is being removed and replaced with a new worker node.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run `ibmcloud login` and then `ibmcloud iam oauth-tokens`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0001", "description": "The provided IAM token is invalid or has expired. Provide a valid IAM token.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud iam oauth-tokens", "terseDescription": "Unauthorized", "type": "Authentication" } } } }, "404": { "description": "Not found. The specified cluster or worker could not be found. To list the clusters that you have access to, use the `GET /vpc/v2/clusters` API or run `ibmcloud ks cluster ls --provider vpc-classic`.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0002", "description": "The requested resource could not be found. Verify the resource ID and try again.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster ls", "terseDescription": "Not found", "type": "NotFound" } } } }, "500": { "description": "Internal Server Error. IBM Cloud Kubernetes Service is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.", "headers": { "X-Request-Id": { "description": "Unique ID for this request", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "E0003", "description": "An internal server error occurred. Try again later or contact support if the problem persists.", "incidentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recoveryCLI": "ibmcloud ks cluster get --cluster ", "terseDescription": "Internal error", "type": "InternalServerError" } } } } }, "x-ibm-events": { "description": "A worker node is removed and another worker node of the same flavor is created in the cluster.", "events": [ { "name": "containers-kubernetes.worker.replace" } ] }, "x-ibm-permissions": { "actions": [ { "name": "containers-kubernetes.cluster.operate" } ], "description": "To get the action, the user must have the Operator platform role to Kubernetes Service in IAM." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \"/global/v2/vpc/replaceWorker\" \\\n", " -H \"Authorization: Bearer $IAM_TOKEN\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\n", " \"cluster\": \"example-value\",\n", " \"update\": false,\n", " \"workerID\": \"example-id-123\"\n", "}'\n" ] } ] } ] } } } } }, "servers": [ { "url": "/global" } ], "components": { "requestBodies": { "IgnoredIngressStatusErrors": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnoredIngressStatusErrors" } } }, "description": "Ingress status errors that are ignored for ingress status reporting.", "required": true }, "Kubeconfig": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Kubeconfig" } } }, "description": "Options to retrieve a kubeconfig file. Default format is 'json', other options include 'yaml' and 'zip'. To retrieve the Calico network config, pass admin:true and format:\"zip\" in the body.", "required": true }, "UpdateServiceEndpoint": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceEndpoint" } } }, "description": "Input parameters to specify the name or ID of the cluster and which service endpoint to update. Valid service endpoints are public or private.", "required": true }, "MultishiftCreateCluster": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultishiftCreateCluster" } } }, "description": "The configuration details for your Satellite cluster, in JSON format. The \"controller\" field (required) is the name or ID of the location to deploy the cluster to. The \"name\" field (required) is the name to give the cluster. The \"kubeVersion\" field is optional, and defaults to the latest Red Hat OpenShift on IBM Cloud version when not specified.", "required": true } }, "schemas": { "ACLResponse": { "description": "ACLResponse response for GET request", "type": "object", "properties": { "actualCSEACLList": { "$ref": "#/components/schemas/CSEACLList" }, "desiredCSEACLList": { "$ref": "#/components/schemas/CSEACLList" } }, "x-go-name": "_ACLResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "ALB": { "description": "ALB stores the configuration for new alb", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "enableByDefault": { "description": "If set to true, the ALB is enabled by default. \\", "type": "boolean", "x-go-name": "EnableByDefault" }, "ingressImage": { "description": "The type of Ingress image that you want to use for your ALB deployment.", "type": "string", "x-go-name": "IngressImage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "description": "The type of ALB that you want to create.", "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "description": "The zone where you want to deploy the ALB.", "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/vpc" }, "ALBClusterHealthCheckConfig": { "description": "ALBClusterHealthCheckConfig status of alb healthcheck", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "enable": { "type": "boolean", "x-go-name": "Enable" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "ALBConfig": { "description": "ALBConfig config for alb configuration", "type": "object", "properties": { "albBuild": { "description": "The build number of the ALB.", "type": "string", "x-go-name": "ALBBuild", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "albID": { "description": "The ID of the application load balancer (ALB).", "type": "string", "x-go-name": "AlbID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "albType": { "description": "The type of ALB.", "type": "string", "x-go-name": "AlbType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "authBuild": { "description": "The auth build of the ALB.", "type": "string", "x-go-name": "AuthBuild", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "description": "The date the ALB was created.", "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableDeployment": { "description": "If set to true, the deployment of the ALB is disabled.", "type": "boolean", "x-go-name": "DisableDeployment" }, "enable": { "description": "Set to true to enable the ALB, or false to disable the ALB for the cluster.", "type": "boolean", "x-go-name": "Enable" }, "loadBalancerHostname": { "type": "string", "x-go-name": "LoadBalancerHostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "description": "The name of the cluster that the ALB belongs to.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "numOfInstances": { "description": "Desired number of ALB replicas that you want in your cluster.", "type": "string", "x-go-name": "NumOfInstances", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resize": { "description": "If set to true, resizing of the ALB is done.", "type": "boolean", "x-go-name": "Resize" }, "state": { "description": "The state of the ALB.", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "description": "The status of the ALB.", "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "description": "The zone where you want to add ALBs.", "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/vpc" }, "ALBSecretConfig": { "type": "object", "title": "ALBSecretConfig represents the configuration of the ALB secret.", "properties": { "certCrn": { "description": "The CRN of the Certificate Manager instance where the TLS certificate is downloaded from.", "type": "string", "x-go-name": "CertCrn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cloudCertInstanceID": { "description": "The Certificate Manager instance ID where the TLS certificate is downloaded from.", "type": "string", "x-go-name": "CloudCertInstanceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterCrn": { "description": "The CRN of the cluster where the ALB secret was created.", "type": "string", "x-go-name": "ClusterCrn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterID": { "description": "The ID of the cluster where the ALB secret was created.", "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domainName": { "description": "The domain name of the TLS certficate that the ALB uses.", "type": "string", "x-go-name": "DomainName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "expiresOn": { "description": "The expiration date of the certficate.", "type": "string", "x-go-name": "ExpiresOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "issuerName": { "description": "The name of the issuer of the certficate.", "type": "string", "x-go-name": "IssuerName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretName": { "description": "The name of the ALB secret.", "type": "string", "x-go-name": "SecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The state of ALB secret.", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "description": "The status of ALB secret.", "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/ingress" }, "AWSCredential": { "description": "AWSCredential required to communicate with Amazon Web Services", "type": "object", "properties": { "client_id": { "type": "string", "x-go-name": "ClientID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client_secret": { "type": "string", "x-go-name": "ClientSecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/multishift" }, "AccountStatus": { "description": "AccountStatus summarises the IaaS user's view of the provider account", "type": "object", "properties": { "account": { "description": "ProviderAccountID may contain personally\nidentifiable information", "type": "string", "x-go-name": "ProviderAccountID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "accountType": { "description": "AccountType returns if the account information pertains to a linked\nor an IaaS account", "type": "string", "x-go-name": "AccountType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkManagerPermissions": { "$ref": "#/components/schemas/Permissions" }, "physicalWorkerManagerPermissions": { "$ref": "#/components/schemas/Permissions" }, "storageManagerPermissions": { "$ref": "#/components/schemas/Permissions" }, "virtualWorkerManagerPermissions": { "$ref": "#/components/schemas/Permissions" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "AckDesiredStorageCapacityRequest": { "description": "AckDesiredStorageCapacityRequest is the request body for ackDesiredStorageConfigCapacity API", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "request-id": { "type": "string", "x-go-name": "RequestID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "AddSubscriptionType": { "type": "object", "title": "AddSubscriptionType ...", "properties": { "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "recoveryCLI": { "type": "string", "x-go-name": "RecoveryCLI", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "AddWorkerCommand": { "description": "AddWorkerCommand represents a generic worker add action", "type": "object", "properties": { "action": { "description": "The type of action to perform on the worker node.", "type": "string", "x-go-name": "Action", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "count": { "description": "The number of operations to perform on the worker node.", "type": "integer", "format": "int64", "x-go-name": "Count", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "Addon": { "description": "Addon properties", "type": "object", "properties": { "enabled": { "type": "boolean", "x-go-name": "Enabled" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "HealthState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "HealthStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "AddonCommon": { "description": "AddonCommon represents common properties of an addon", "type": "object", "required": [ "name" ], "properties": { "defaultVersions": { "description": "The addon default versions based on supported cluster version/provider", "type": "array", "items": { "$ref": "#/components/schemas/AddonDefaultVersion" }, "x-go-name": "Defaults", "minItems": 0, "maxItems": 100 }, "installOptionsTemplate": { "$ref": "#/components/schemas/AddonOptionsTemplate" }, "minKubeVersion": { "description": "The minimum kubernetes version for this addon.", "type": "string", "x-go-name": "MinKubeVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minOCPVersion": { "description": "The minimum OpenShift version for this addon.", "type": "string", "x-go-name": "MinOCPVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "description": "The addon name such as 'istio'.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offeringsThatPreventDisable": { "description": "The offerings that do not support disabling the addon", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "OfferingsThatPreventDisable", "minItems": 0, "maxItems": 100 }, "supportedInternalProviders": { "description": "The addon supported providers.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedInternalProviders", "minItems": 0, "maxItems": 100 }, "supportedKubeRange": { "description": "The supported kubernetes version range for this addon.", "type": "string", "x-go-name": "SupportedKubeRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedOCPRange": { "description": "The supported Openshift version range for this addon.", "type": "string", "x-go-name": "SupportedOCPRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedOpenShiftVSRange": { "description": "The supported Red Hat OpenShift Virtualization Service (openshift-vs) version range for this addon.", "type": "string", "x-go-name": "SupportedOpenShiftVSRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "targetVersion": { "description": "The addon target version.", "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "description": "The addon version, omit the version if you wish to use the default version.", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vlan_spanning_required": { "description": "VLAN spanning required for multi-zone clusters", "type": "boolean", "x-go-name": "VLANSpanningRequired" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "AddonDefaultVersion": { "description": "AddonDefaultVersion represents a default version for an addon\nwhich can be specified for a specific version or provider", "type": "object", "properties": { "infrastructureProvider": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Provider", "minItems": 0, "maxItems": 100 }, "kubeRange": { "type": "string", "x-go-name": "KubeRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ocpRange": { "type": "string", "x-go-name": "OCPRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "type": "string", "x-go-name": "DefaultVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "AddonOptionsTemplate": { "description": "AddonOptionsTemplate represents the options for an addon", "type": "object", "properties": { "content": { "type": "string", "x-go-name": "Content", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "immutable": { "type": "boolean", "x-go-name": "Immutable" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "AddonRequest": { "description": "AddonRequest represents one add on request", "type": "object", "required": [ "addons" ], "properties": { "addons": { "description": "The addons to operate on.", "type": "array", "items": { "$ref": "#/components/schemas/ClusterAddon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "enable": { "description": "Indicate if the specified addons should be enabled or disabled.", "type": "boolean", "x-go-name": "Enable" }, "update": { "description": "Indicate if the specified addons should be updated. Only Update or Enable should be used, not both.", "type": "boolean", "x-go-name": "Update" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "AddonResponse": { "description": "AddonResponse represents an addon response", "type": "object", "properties": { "missingDeps": { "description": "The addon enable request would result in an invalid configuration. Install missing addons to continue.", "type": "array", "items": { "$ref": "#/components/schemas/ClusterAddon" }, "x-go-name": "MissingDeps", "minItems": 0, "maxItems": 100 }, "orphanedAddons": { "description": "The addon disable request would result in an invalid configuration. Inspect the map to determine why the configuration is invalid.", "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterAddon" }, "minItems": 0, "maxItems": 100 }, "x-go-name": "Orphaned" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "AkamaiCredentials": { "description": "AkamaiCredentials is the struct representation of Akamai creds", "type": "object", "properties": { "access_token": { "type": "string", "x-go-name": "AccessToken", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client_secret": { "type": "string", "x-go-name": "ClientSecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client_token": { "type": "string", "x-go-name": "ClientToken", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "host": { "type": "string", "x-go-name": "Host", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "AkamaiHealthcheckProperties": { "description": "AkamaiHealthcheckProperties used for storing config provided by user for akamai healthcheck\ndeprecated", "type": "object", "properties": { "httpError3xx": { "type": "boolean", "x-go-name": "HTTPError3xx" }, "httpError4xx": { "type": "boolean", "x-go-name": "HTTPError4xx" }, "httpError5xx": { "type": "boolean", "x-go-name": "HTTPError5xx" }, "httpHeaders": { "type": "array", "items": { "$ref": "#/components/schemas/HTTPHeader" }, "x-go-name": "HTTPHeaders", "minItems": 0, "maxItems": 100 }, "httpMethod": { "type": "string", "x-go-name": "HTTPMethod", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "peerCertificateVerification": { "type": "boolean", "x-go-name": "PeerCertificateVerification" }, "testInterval": { "type": "integer", "format": "int64", "x-go-name": "TestInterval", "minimum": 0, "maximum": 2147483647 }, "testObject": { "type": "string", "x-go-name": "TestObject", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "testObjectPort": { "type": "integer", "format": "int64", "x-go-name": "TestObjectPort", "minimum": 0, "maximum": 2147483647 }, "testObjectProtocol": { "type": "string", "x-go-name": "TestObjectProtocol", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "testTimeout": { "type": "number", "format": "float", "x-go-name": "TestTimeout" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "AlbCreateResp": { "description": "AlbCreateResp used to send back the albid on a create request", "type": "object", "properties": { "alb": { "type": "string", "x-go-name": "Alb", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "AppliedStorageConfig": { "description": "AppliedStorageConfig contains the details of an assigned storage config on a cluster\nA list of AppliedStorageConfig structs is the response for the GetAssignedStorageConfigs query", "type": "object", "properties": { "assignment-uuid": { "type": "string", "x-go-name": "AssignmentUUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "config-attributes": { "type": "object", "properties": { "offering-name": { "type": "string", "x-go-name": "OfferingName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-classes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "StorageClasses", "minItems": 0, "maxItems": 100 }, "template-name": { "type": "string", "x-go-name": "TemplateName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "template-version": { "type": "string", "x-go-name": "TemplateVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "total-capacity": { "type": "string", "x-go-name": "TotalCapacity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-availability": { "type": "string", "x-go-name": "VolumeAvailability", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-encryption-at-rest": { "type": "string", "x-go-name": "VolumeEncryptionAtRest", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-expansion": { "type": "string", "x-go-name": "VolumeExpansion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-snapshot": { "type": "string", "x-go-name": "VolumeSnapshot", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-type": { "type": "string", "x-go-name": "VolumeType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "ConfigAttributes" }, "config-name": { "type": "string", "x-go-name": "ConfigName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "config-uuid": { "type": "string", "x-go-name": "ConfigUUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "rollout-status": { "type": "object", "properties": { "error-count": { "type": "integer", "format": "int64", "x-go-name": "ErrorCount", "minimum": 0, "maximum": 2147483647 }, "success-count": { "type": "integer", "format": "int64", "x-go-name": "SuccessCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-name": "RolloutStatus" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "Assignment": { "description": "Assignment is information about the host assignment", "type": "object", "properties": { "clusterID": { "description": "The cluster ID that the host is assigned to", "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterName": { "description": "The cluster name that the host is assigned to", "type": "string", "x-go-name": "ClusterName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ipAddress": { "description": "The IP address assigned to the host", "type": "string", "x-go-name": "IPAddress", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "receivedDate": { "description": "The timestamp when assignment request was received and began to execute resources on the host", "type": "string", "x-go-name": "ReceivedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "requestedDate": { "description": "The timestamp of the request to assign the host", "type": "string", "x-go-name": "RequestedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "updateSeverity": { "description": "Indicates how severely this worker node needs to be updated based on version drift.\nPossible values: \"\" (no update needed), warning (behind by patch/build version), critical (behind by major/minor version).", "type": "string", "x-go-name": "UpdateSeverity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerID": { "description": "The worker node ID that the host is assigned to", "type": "string", "x-go-name": "WorkerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPoolID": { "description": "The worker pool ID within the cluster that the host is assigned to", "type": "string", "x-go-name": "WorkerPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPoolName": { "description": "The worker pool name within the cluster that the host is assigned to", "type": "string", "x-go-name": "WorkerPoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "description": "The zone within the cluster that the host is assigned to", "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "AuditWebhookConfig": { "type": "object", "title": "AuditWebhookConfig contains user data to set up the auditing configuration in a cluster.", "properties": { "auditServer": { "description": "The URL of the server to send audit logs to.", "type": "string", "x-go-name": "AuditServer", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "caCertificate": { "description": "The Certificate Authority certificate that is used to connect to the audit server.", "type": "string", "x-go-name": "CACertificate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clientCertificate": { "description": "The client certificate that is used to connect to the audit server.", "type": "string", "x-go-name": "ClientCertificate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clientKey": { "description": "The client key that is used to connect to the audit server.", "type": "string", "x-go-name": "ClientKey", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "policy": { "description": "The audit policy type to be configured.", "type": "string", "x-go-name": "Policy", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "AutoUpdateMaster": { "description": "AutoUpdateMaster defines the payload required to enable / disable master autoupdates", "type": "object", "properties": { "autoUpdate": { "type": "boolean", "x-go-name": "AutoUpdate" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "AutoscaleConfig": { "description": "AutoscaleConfig is used for configuring autoscaling for albs", "type": "object", "properties": { "cpuAverageUtilization": { "type": "integer", "format": "int32", "x-go-name": "CPUAverageUtilization", "minimum": 0, "maximum": 2147483647 }, "customMetrics": { "type": "string", "x-go-name": "CustomMetrics", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "maxReplicas": { "type": "integer", "format": "int32", "x-go-name": "MaxReplicas", "minimum": 0, "maximum": 2147483647 }, "minReplicas": { "type": "integer", "format": "int32", "x-go-name": "MinReplicas", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "AutoscaleDetails": { "description": "AutoscaleDetails is used for configuring autoscaling for albs", "type": "object", "properties": { "config": { "$ref": "#/components/schemas/AutoscaleConfig" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "AvailableStorageClasses": { "description": "AvailableStorageClasses contains a list of storage class names\nIt is the response for GetAvailableStorageClasses query", "type": "object", "properties": { "storage-classes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "StorageClasses", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "AzureCredential": { "description": "AzureCredential required to communicate with Azure", "type": "object", "properties": { "app_id": { "type": "string", "x-go-name": "AppID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "password": { "type": "string", "x-go-name": "Password", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "tenant_id": { "type": "string", "x-go-name": "TenantID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/multishift" }, "BOMVersion": { "description": "BOMVersion the full BOM version including KubeVersion", "type": "object", "properties": { "Build": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "Flavor": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "default": { "type": "boolean", "x-go-name": "Default" }, "end_of_service": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "major": { "type": "integer", "format": "int64", "x-go-name": "Major", "minimum": 0, "maximum": 2147483647 }, "minor": { "type": "integer", "format": "int64", "x-go-name": "Minor", "minimum": 0, "maximum": 2147483647 }, "patch": { "type": "integer", "format": "int64", "x-go-name": "Patch", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "BackendAttributes": { "description": "BackendAttributes defines attributes related to storage backend", "type": "object", "properties": { "max-volume-size": { "type": "string", "x-go-name": "MaxVolumeSize", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "total-capacity": { "type": "string", "x-go-name": "TotalCapacity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "BluemixConfig": { "type": "object", "title": "BluemixConfig contains many shared keys for endpoint URLs. Useful for loading via envconfig.", "properties": { "accounts_url": { "type": "string", "x-go-name": "AccountsURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "acct_url": { "description": "Deprecated: the account and user management APIs are now separated to AccountsURL and UserManagementURL respectively", "type": "string", "x-go-name": "AccountURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "bluemix_url": { "type": "string", "x-go-name": "BluemixURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "env_name": { "type": "string", "x-go-name": "EnvName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iam_base_url": { "type": "string", "x-go-name": "IamBaseURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iam_client_id": { "type": "string", "x-go-name": "IamClientID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iam_client_secret": { "type": "string", "x-go-name": "IamClientSecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iam_issuer": { "type": "string", "x-go-name": "IamIssuer", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iam_papurl": { "type": "string", "x-go-name": "IamPAPURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iam_pdpurl": { "type": "string", "x-go-name": "IamPDPURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iam_url": { "type": "string", "x-go-name": "IamURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "uaa_url": { "type": "string", "x-go-name": "UAAURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "user_management_url": { "type": "string", "x-go-name": "UserManagementURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "BoundService": { "description": "BoundService properties", "type": "object", "properties": { "namespace": { "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceid": { "type": "string", "x-go-name": "ServiceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "servicekeyname": { "type": "string", "x-go-name": "ServiceKeyName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "servicename": { "type": "string", "x-go-name": "ServiceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "COSAuthorization": { "description": "COSAuthorization Optional: IBM Cloud Object Storage authorization keys", "type": "object", "properties": { "access_key-id": { "description": "The HMAC secret access key ID", "type": "string", "x-go-name": "AccessKeyID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secret_access_key": { "description": "The HMAC secret access key", "type": "string", "x-go-name": "SecretAccessKey", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "COSBucket": { "description": "COSBucket Optional: IBM Cloud Object Storage bucket configuration details", "type": "object", "properties": { "bucket": { "type": "string", "x-go-name": "Bucket", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "endpoint": { "type": "string", "x-go-name": "Endpoint", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceInstance": { "type": "object", "properties": { "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "ServiceInstance" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CSEACLList": { "description": "CSEACLList actual and desired", "type": "object", "properties": { "customAclEntries": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "CustomACLEntries", "minItems": 0, "maxItems": 100 }, "systemAclEntries": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SystemACLEntries", "minItems": 0, "maxItems": 100 } }, "x-go-name": "_CSEACLList", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "CapabilityManagedBySatellite": { "description": "CapabilityManagedBySatellite is a custom type for satellite capabilities", "type": "string", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ClassicCreateWorkerPoolFragment": { "type": "object", "title": "ClassicCreateWorkerPoolFragment contains the fields necessary to request a classid worker pool.", "properties": { "reservation": { "type": "string", "x-go-name": "Reservation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ClassicCreateWorkerPoolZone": { "description": "ClassicCreateWorkerPoolZone contains all fields in the zone part of\nVPC requests to create worker pools.", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ClassicCreateWorkerPoolZoneFragment": { "type": "object", "title": "ClassicCreateWorkerPoolZoneFragment contains the zone fields necessary to request a classic worker pool.", "properties": { "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ClassicWorkerPoolZoneAdd": { "description": "ClassicWorkerPoolZoneAdd is the classic part of the createWorkerPoolZone request", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ClassicWorkerPoolZoneAddFragment": { "description": "ClassicWorkerPoolZoneAddFragment contains fields unique to classic", "type": "object", "properties": { "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CleanupResponse": { "description": "CleanupResponse represents results of the migration cleanup process", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "removedResources": { "description": "RemovedResources keys are namespaces values are slices of resource names in \"Kind/name\" format", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minItems": 0, "maxItems": 100 }, "x-go-name": "RemovedResources" }, "removedTestController": { "type": "boolean", "x-go-name": "RemovedTestController" }, "removedTestSubdomain": { "type": "boolean", "x-go-name": "RemovedTestSubdomain" }, "resetCommunityControllerConfigMap": { "type": "boolean", "x-go-name": "ResetCommunityControllerConfigMap" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "ClientKubeConfig": { "description": "ClientKubeConfig is the kubernetes config file used by kubectl", "type": "object", "properties": { "apiVersion": { "description": "Legacy field from pkg/api/types.go TypeMeta.", "type": "string", "x-go-name": "APIVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusters": { "description": "Clusters is a map of referencable names to cluster configs", "type": "array", "items": { "type": "object", "properties": { "cluster": { "description": "Cluster holds the cluster information", "type": "object", "properties": { "certificate-authority": { "description": "CertificateAuthority is the path to a cert file for the certificate authority.", "type": "string", "x-go-name": "CertificateAuthority", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "certificate-authority-data": { "description": "CertificateAuthorityData contains PEM-encoded certificate authority certificates. Overrides CertificateAuthority", "type": "string", "x-go-name": "CertificateAuthorityData", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disable-compression": { "description": "DisableCompression allows client to opt-out of response compression for all requests to the server. This is useful\nto speed up requests (specifically lists) when client-server network bandwidth is ample, by saving time on\ncompression (server-side) and decompression (client-side): https://github.com/kubernetes/kubernetes/issues/112296.", "type": "boolean", "x-go-name": "DisableCompression" }, "insecure-skip-tls-verify": { "description": "InsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure.", "type": "boolean", "x-go-name": "InsecureSkipTLSVerify" }, "proxy-url": { "description": "ProxyURL is the URL to the proxy to be used for all requests made by this\nclient. URLs with \"http\", \"https\", and \"socks5\" schemes are supported. If\nthis configuration is not provided or the empty string, the client\nattempts to construct a proxy configuration from http_proxy and\nhttps_proxy environment variables. If these environment variables are not\nset, the client does not attempt to proxy requests.\n\nsocks5 proxying does not currently support spdy streaming endpoints (exec,\nattach, port forward).", "type": "string", "x-go-name": "ProxyURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "server": { "description": "Server is the address of the kubernetes cluster (https://hostname:port).", "type": "string", "x-go-name": "Server", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "tls-server-name": { "description": "TLSServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used.", "type": "string", "x-go-name": "TLSServerName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "Cluster" }, "name": { "description": "Name is the nickname for this Cluster", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } } }, "x-go-name": "Clusters", "minItems": 0, "maxItems": 100 }, "contexts": { "description": "Contexts is a map of referencable names to context configs", "type": "array", "items": { "type": "object", "properties": { "context": { "description": "Context holds the context information", "type": "object", "properties": { "cluster": { "description": "Cluster is the name of the cluster for this context", "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "description": "Namespace is the default namespace to use on unspecified requests", "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "user": { "description": "AuthInfo is the name of the authInfo for this context", "type": "string", "x-go-name": "AuthInfo", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "Context" }, "name": { "description": "Name is the nickname for this Context", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } } }, "x-go-name": "Contexts", "minItems": 0, "maxItems": 100 }, "current-context": { "description": "CurrentContext is the name of the context that you would like to use by default", "type": "string", "x-go-name": "CurrentContext", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kind": { "description": "Legacy field from pkg/api/types.go TypeMeta.", "type": "string", "x-go-name": "Kind", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "preferences": { "description": "Preferences holds general information to be use for cli interactions", "type": "object", "properties": { "colors": { "type": "boolean", "x-go-name": "Colors" } }, "x-go-name": "Preferences" }, "users": { "description": "AuthInfos is a map of referencable names to user configs", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Name is the nickname for this AuthInfo", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "user": { "description": "AuthInfo holds the auth information", "type": "object", "properties": { "as": { "description": "Impersonate is the username to impersonate. The name matches the flag.", "type": "string", "x-go-name": "Impersonate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "as-groups": { "description": "ImpersonateGroups is the groups to impersonate.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "ImpersonateGroups", "minItems": 0, "maxItems": 100 }, "as-uid": { "description": "ImpersonateUID is the uid to impersonate.", "type": "string", "x-go-name": "ImpersonateUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "as-user-extra": { "description": "ImpersonateUserExtra contains additional information for impersonated user.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minItems": 0, "maxItems": 100 }, "x-go-name": "ImpersonateUserExtra" }, "auth-provider": { "description": "AuthProvider specifies a custom authentication plugin for the kubernetes cluster.", "type": "object", "properties": { "config": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Config" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "AuthProvider" }, "client-certificate": { "description": "ClientCertificate is the path to a client cert file for TLS.", "type": "string", "x-go-name": "ClientCertificate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client-certificate-data": { "description": "ClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate", "type": "string", "x-go-name": "ClientCertificateData", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client-key": { "description": "ClientKey is the path to a client key file for TLS.", "type": "string", "x-go-name": "ClientKey", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client-key-data": { "description": "ClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKey", "type": "string", "x-go-name": "ClientKeyData", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "exec": { "description": "Exec specifies a custom exec-based authentication plugin for the kubernetes cluster.", "type": "object", "properties": { "apiVersion": { "description": "Preferred input version of the ExecInfo. The returned ExecCredentials MUST use\nthe same encoding version as the input.", "type": "string", "x-go-name": "APIVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "args": { "description": "Arguments to pass to the command when executing it.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Args", "minItems": 0, "maxItems": 100 }, "command": { "description": "Command to execute.", "type": "string", "x-go-name": "Command", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "env": { "description": "Env defines additional environment variables to expose to the process. These\nare unioned with the host's environment, as well as variables client-go uses\nto pass argument to the plugin.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "value": { "type": "string", "x-go-name": "Value", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } } }, "x-go-name": "Env", "minItems": 0, "maxItems": 100 }, "installHint": { "description": "This text is shown to the user when the executable doesn't seem to be\npresent. For example, `brew install foo-cli` might be a good InstallHint for\nfoo-cli on Mac OS systems.", "type": "string", "x-go-name": "InstallHint", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "interactiveMode": { "description": "InteractiveMode determines this plugin's relationship with standard input. Valid\nvalues are \"Never\" (this exec plugin never uses standard input), \"IfAvailable\" (this\nexec plugin wants to use standard input if it is available), or \"Always\" (this exec\nplugin requires standard input to function). See ExecInteractiveMode values for more\ndetails.\n\nIf APIVersion is client.authentication.k8s.io/v1alpha1 or\nclient.authentication.k8s.io/v1beta1, then this field is optional and defaults\nto \"IfAvailable\" when unset. Otherwise, this field is required.\n+optional", "type": "string", "x-go-name": "InteractiveMode", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provideClusterInfo": { "description": "ProvideClusterInfo determines whether or not to provide cluster information,\nwhich could potentially contain very large CA data, to this exec plugin as a\npart of the KUBERNETES_EXEC_INFO environment variable. By default, it is set\nto false. Package k8s.io/client-go/tools/auth/exec provides helper methods for\nreading this environment variable.", "type": "boolean", "x-go-name": "ProvideClusterInfo" } }, "x-go-name": "Exec" }, "password": { "description": "Password is the password for basic authentication to the kubernetes cluster.", "type": "string", "x-go-name": "Password", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "token": { "description": "Token is the bearer token for authentication to the kubernetes cluster.", "type": "string", "x-go-name": "Token", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "tokenFile": { "description": "TokenFile is a pointer to a file that contains a bearer token (as described above). If both Token and TokenFile are present, Token takes precedence.", "type": "string", "x-go-name": "TokenFile", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "username": { "description": "Username is the username for basic authentication to the kubernetes cluster.", "type": "string", "x-go-name": "Username", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "AuthInfo" } } }, "x-go-name": "AuthInfos", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "CloudflareCredentials": { "description": "CloudflareCredentials is the struct representation of Cloudflare creds", "type": "object", "properties": { "token": { "type": "string", "x-go-name": "Token", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone_id": { "type": "string", "x-go-name": "ZoneID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "Cluster": { "description": "Cluster properties", "type": "object", "properties": { "addons": { "type": "array", "items": { "$ref": "#/components/schemas/Addon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "apiUser": { "type": "string", "x-go-name": "APIUser", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dataCenter": { "type": "string", "x-go-name": "DataCenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredTrustedProfileID": { "type": "string", "x-go-name": "DesiredTrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "etcdPort": { "type": "string", "x-go-name": "EtcdPort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ignitionServerURL": { "type": "string", "x-go-name": "IgnitionServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "imageSecurityEnabled": { "type": "boolean", "x-go-name": "ImageSecurityEnabled" }, "ingressHostname": { "type": "string", "x-go-name": "IngressHostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressMessage": { "type": "string", "x-go-name": "IngressMessage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressSecretName": { "type": "string", "x-go-name": "IngressSecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressStatus": { "type": "string", "x-go-name": "IngressStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "keyProtectEnabled": { "type": "boolean", "x-go-name": "KeyProtectEnabled" }, "konnectivityServerURL": { "type": "string", "x-go-name": "KonnectivityServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logOrg": { "type": "string", "x-go-name": "OrgID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logOrgName": { "type": "string", "x-go-name": "OrgName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSpace": { "type": "string", "x-go-name": "SpaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSpaceName": { "type": "string", "x-go-name": "SpaceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterHealth": { "type": "string", "x-go-name": "MasterHealth", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterKubeVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterState": { "type": "string", "x-go-name": "MasterState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatus": { "type": "string", "x-go-name": "MasterStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatusModifiedDate": { "type": "string", "x-go-name": "MasterStatusModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "modifiedDate": { "type": "string", "x-go-name": "ModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "monitoringURL": { "type": "string", "x-go-name": "MonitoringURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multiAzCapable": { "type": "boolean", "x-go-name": "MultiAZCapable" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "oauthServerURL": { "type": "string", "x-go-name": "OauthServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnets": { "type": "string", "x-go-name": "PodSubnets", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PrivateServiceEndpointEnabled" }, "privateServiceEndpointURL": { "type": "string", "x-go-name": "PrivateServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PublicServiceEndpointEnabled" }, "publicServiceEndpointURL": { "type": "string", "x-go-name": "PublicServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pullSecretApplied": { "type": "boolean", "x-go-name": "PullSecretApplied" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serverURL": { "type": "string", "x-go-name": "ServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/VlanConfigField" }, "x-go-name": "SubnetVLANs", "minItems": 0, "maxItems": 100 }, "vpcNativeRoutingEnabled": { "type": "boolean", "x-go-name": "VPCNativeRoutingEnabled" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "WorkerZones", "minItems": 0, "maxItems": 100 }, "worker_vlans": { "$ref": "#/components/schemas/VLANS" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "ClusterALB": { "description": "ClusterALB alb related information for cluster", "type": "object", "properties": { "alb": { "description": "PrivateIngressHostname string `json:\"privateIngressHostname\"`\nPrivateIngressSecretName string `json:\"privateIngressSecretName\"`", "type": "array", "items": { "$ref": "#/components/schemas/ALBConfig" }, "x-go-name": "ALBs", "minItems": 0, "maxItems": 100 }, "dataCenter": { "type": "string", "x-go-name": "DataCenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressHostname": { "type": "string", "x-go-name": "IngressHostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressSecretName": { "type": "string", "x-go-name": "IngressSecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/ingress" }, "ClusterALBSecret": { "type": "object", "title": "ClusterALBSecret includes information about the ALB secret of a cluster.", "properties": { "albSecrets": { "description": "A list of ALB secrets that were created for a cluster.", "type": "array", "items": { "$ref": "#/components/schemas/ALBSecretConfig" }, "x-go-name": "ALBSecrets", "minItems": 0, "maxItems": 100 }, "dataCenter": { "type": "string", "x-go-name": "DataCenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/ingress" }, "ClusterAddon": { "description": "ClusterAddon represents one add on", "type": "object", "required": [ "name" ], "properties": { "allowed_upgrade_versions": { "description": "The versions that the addon can be upgraded to", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AllowedUpgradeVersions", "minItems": 0, "maxItems": 100 }, "defaultVersions": { "description": "The addon default versions based on supported cluster version/provider", "type": "array", "items": { "$ref": "#/components/schemas/AddonDefaultVersion" }, "x-go-name": "Defaults", "minItems": 0, "maxItems": 100 }, "deprecated": { "description": "Determines if this addon version is deprecated", "type": "boolean", "x-go-name": "Deprecated" }, "healthState": { "description": "The health state for this addon, a short indication (e.g. critical, pending)", "type": "string", "x-go-name": "HealthState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "healthStatus": { "description": "The health status for this addon, provides a description of the state (e.g. error message)", "type": "string", "x-go-name": "HealthStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "installOptionsTemplate": { "$ref": "#/components/schemas/AddonOptionsTemplate" }, "minKubeVersion": { "description": "The minimum kubernetes version for this addon.", "type": "string", "x-go-name": "MinKubeVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minOCPVersion": { "description": "The minimum OpenShift version for this addon.", "type": "string", "x-go-name": "MinOCPVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "description": "The addon name such as 'istio'.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offeringsThatPreventDisable": { "description": "The offerings that do not support disabling the addon", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "OfferingsThatPreventDisable", "minItems": 0, "maxItems": 100 }, "options": { "description": "The addon options. Should be a yaml for a kube resource.", "type": "string", "x-go-name": "Options", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedInternalProviders": { "description": "The addon supported providers.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedInternalProviders", "minItems": 0, "maxItems": 100 }, "supportedKubeRange": { "description": "The supported kubernetes version range for this addon.", "type": "string", "x-go-name": "SupportedKubeRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedOCPRange": { "description": "The supported Openshift version range for this addon.", "type": "string", "x-go-name": "SupportedOCPRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedOpenShiftVSRange": { "description": "The supported Red Hat OpenShift Virtualization Service (openshift-vs) version range for this addon.", "type": "string", "x-go-name": "SupportedOpenShiftVSRange", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "targetVersion": { "description": "The addon target version.", "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "description": "The addon version, omit the version if you wish to use the default version.", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vlan_spanning_required": { "description": "VLAN spanning required for multi-zone clusters", "type": "boolean", "x-go-name": "VLANSpanningRequired" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "ClusterAddonResponse": { "description": "ClusterAddon is an enabled add on in the cluster", "type": "object", "properties": { "allowedUpgradeVersions": { "description": "A list of available versions that this add on can be updated to", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AllowedUpgradeVersions", "minItems": 0, "maxItems": 100 }, "defaultVersions": { "description": "The addon default versions based on supported cluster version/provider", "type": "array", "items": { "$ref": "#/components/schemas/AddonDefaultVersion" }, "x-go-name": "Defaults", "minItems": 0, "maxItems": 100 }, "deprecated": { "description": "Is this particular addon version deprecated?", "type": "boolean", "x-go-name": "Deprecated" }, "healthState": { "description": "The current health state of the add on", "type": "string", "x-go-name": "HealthState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "healthStatus": { "description": "A status message to accompany the health state", "type": "string", "x-go-name": "HealthStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "installOptionsTemplate": { "$ref": "#/components/schemas/AddonOptionsTemplate" }, "name": { "description": "The name of the add on", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "options": { "description": "The addon options. Should be a yaml for a kube resource.", "type": "string", "x-go-name": "Options", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "preventDisable": { "description": "Is this addon allowed to be disabled?", "type": "boolean", "x-go-name": "PreventDisable" }, "targetVersion": { "description": "The latest stable version", "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "description": "The configured version of the add on", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "ClusterAddon", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "ClusterCommon": { "description": "ClusterCommon provides cluster properties", "type": "object", "properties": { "addons": { "type": "array", "items": { "$ref": "#/components/schemas/Addon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "apiUser": { "type": "string", "x-go-name": "APIUser", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredTrustedProfileID": { "type": "string", "x-go-name": "DesiredTrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "etcdPort": { "type": "string", "x-go-name": "EtcdPort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ignitionServerURL": { "type": "string", "x-go-name": "IgnitionServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "imageSecurityEnabled": { "type": "boolean", "x-go-name": "ImageSecurityEnabled" }, "ingressHostname": { "type": "string", "x-go-name": "IngressHostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressMessage": { "type": "string", "x-go-name": "IngressMessage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressSecretName": { "type": "string", "x-go-name": "IngressSecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressStatus": { "type": "string", "x-go-name": "IngressStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "keyProtectEnabled": { "type": "boolean", "x-go-name": "KeyProtectEnabled" }, "konnectivityServerURL": { "type": "string", "x-go-name": "KonnectivityServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logOrg": { "type": "string", "x-go-name": "OrgID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logOrgName": { "type": "string", "x-go-name": "OrgName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSpace": { "type": "string", "x-go-name": "SpaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSpaceName": { "type": "string", "x-go-name": "SpaceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterHealth": { "type": "string", "x-go-name": "MasterHealth", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterKubeVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterState": { "type": "string", "x-go-name": "MasterState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatus": { "type": "string", "x-go-name": "MasterStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatusModifiedDate": { "type": "string", "x-go-name": "MasterStatusModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "modifiedDate": { "type": "string", "x-go-name": "ModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "monitoringURL": { "type": "string", "x-go-name": "MonitoringURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "oauthServerURL": { "type": "string", "x-go-name": "OauthServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnets": { "type": "string", "x-go-name": "PodSubnets", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PrivateServiceEndpointEnabled" }, "privateServiceEndpointURL": { "type": "string", "x-go-name": "PrivateServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PublicServiceEndpointEnabled" }, "publicServiceEndpointURL": { "type": "string", "x-go-name": "PublicServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pullSecretApplied": { "type": "boolean", "x-go-name": "PullSecretApplied" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serverURL": { "type": "string", "x-go-name": "ServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The lifecycle state of the cluster. Possible values include aborted, critical, delete_failed, deleted, deleting, deploy_failed, deploying, normal, pending, requested, updating, unsupported, and warning. For more information, see the docs 'http://ibm.biz/cluster-health-states'", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcNativeRoutingEnabled": { "type": "boolean", "x-go-name": "VPCNativeRoutingEnabled" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "ClusterConfig": { "description": "ClusterConfig config needed to create a cluster", "type": "object", "properties": { "cseAclEnabled": { "type": "boolean", "x-go-name": "CSEACLEnabled" }, "dataCenter": { "description": "The data center where the worker node is created.", "type": "string", "x-go-name": "DataCenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultWorkerPoolEntitlement": { "type": "string", "x-go-name": "DefaultWorkerPoolEntitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultWorkerPoolName": { "type": "string", "x-go-name": "DefaultWorkerPoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "gatewayEnabled": { "type": "boolean", "x-go-name": "GatewayEnabled" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "machineType": { "description": "The machine type of the worker node.", "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "noSubnet": { "type": "boolean", "x-go-name": "NoSubnet" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnets": { "type": "string", "x-go-name": "PodSubnets", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "prefix": { "type": "string", "x-go-name": "Prefix", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateSeviceEndpoint": { "type": "boolean", "x-go-name": "PrivateEndpointEnabled" }, "privateVlan": { "description": "The private VLAN ID that the worker node is attached to.", "type": "string", "x-go-name": "PrivateVlan", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicServiceEndpoint": { "type": "boolean", "x-go-name": "PublicEndpointEnabled" }, "publicVlan": { "description": "The public VLAN ID that the worker node is attached to.", "type": "string", "x-go-name": "PublicVlan", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "skipPermPrecheck": { "type": "boolean", "x-go-name": "SkipPermissionPrecheck" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcNativeRoutingEnabled": { "type": "boolean", "x-go-name": "VPCNativeRoutingEnabled" }, "workerNum": { "type": "integer", "format": "int64", "x-go-name": "WorkerNum", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "ClusterConfigCommon": { "description": "ClusterConfigCommon common fields between V1 and V2 APIs", "type": "object", "properties": { "defaultWorkerPoolName": { "type": "string", "x-go-name": "DefaultWorkerPoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "masterVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "noSubnet": { "type": "boolean", "x-go-name": "NoSubnet" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnets": { "type": "string", "x-go-name": "PodSubnets", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "skipPermPrecheck": { "type": "boolean", "x-go-name": "SkipPermissionPrecheck" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcNativeRoutingEnabled": { "type": "boolean", "x-go-name": "VPCNativeRoutingEnabled" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "ClusterCreateResponse": { "description": "ClusterCreateResponse is returned during a successful create cluster command", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "non_critical_errors": { "$ref": "#/components/schemas/ResponseErrors" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "ClusterKeyOwnerInfo": { "description": "ClusterKeyOwnerInfo stores the token owner's information", "type": "object", "properties": { "email": { "type": "string", "x-go-name": "Email", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "ClusterMasterAddon": { "description": "ClusterMasterAddon represents a Chief master addon, including properties like the YAML definition, date, if it is enabled, and retry info", "type": "object", "properties": { "AddonName": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ClusterID": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDCreateDate": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDEnabled": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDErrorMessage": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDRetry": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDRetryTTL": { "$ref": "#/components/schemas/Duration" }, "DEPRECATEDState": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDUpdatedBy": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDUpdatedDate": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDYAML": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "MasterID": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "Region": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "Service": { "description": "Deprecated", "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/chief" }, "ClusterNlbHostsList": { "description": "ClusterNlbHostsList used for storing Nlbs, NlbMonitor, NlbHealthCheckStatus", "type": "object", "properties": { "clusterid": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbHealthCheckConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/NlbHealthCheckConfig" }, "x-go-name": "NlbMonitors", "minItems": 0, "maxItems": 100 }, "nlbHealthCheckStatus": { "type": "array", "items": { "$ref": "#/components/schemas/NlbHealthCheckStatus" }, "x-go-name": "NlbHCStatus", "minItems": 0, "maxItems": 100 }, "nlbs": { "type": "array", "items": { "$ref": "#/components/schemas/NlbConfig" }, "x-go-name": "Nlbs", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "ClusterWebhook": { "description": "ClusterWebhook webhook info", "type": "object", "properties": { "level": { "description": "The notification level that you want to use for the webhook.", "type": "string", "x-go-name": "Level", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "description": "The webhook service type.", "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "url": { "description": "The webhook URL.", "type": "string", "x-go-name": "URL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "CommonClusterAddon": { "description": "CommonClusterAddon properties", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "CommonClusterCACertRotation": { "description": "CommonClusterCACertRotation CA cert rotation properties", "type": "object", "properties": { "actionCompletedDate": { "type": "string", "x-go-name": "ActionCompletedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "actionTriggerDate": { "type": "string", "x-go-name": "ActionTriggerDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "CommonClusterFeatures": { "type": "object", "title": "CommonClusterFeatures provides information about the cluster addons.", "properties": { "keyProtectEnabled": { "type": "boolean", "x-go-name": "KeyProtectEnabled" }, "pullSecretApplied": { "type": "boolean", "x-go-name": "PullSecretApplied" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "CommonClusterIngress": { "type": "object", "title": "CommonClusterIngress provides information about the cluster ingress.", "properties": { "hostname": { "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretName": { "type": "string", "x-go-name": "SecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "CommonClusterKMS": { "type": "object", "title": "CommonClusterKMS provides information about the Key Management Service for the cluster.", "properties": { "actualInstance": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "ActualInstanceCRN", "minItems": 0, "maxItems": 100 }, "actualRootKey": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "ActualRootKeyID", "minItems": 0, "maxItems": 100 }, "desiredInstance": { "type": "string", "x-go-name": "DesiredInstanceCRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredRootKey": { "type": "string", "x-go-name": "DesiredRootKeyID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "CommonClusterLifecycle": { "type": "object", "title": "CommonClusterLifecycle provides information about the state of a cluster.", "properties": { "masterHealth": { "description": "The health of the cluster master. Possible values include error, normal, unavailable, and unsupported. For more information, see the docs 'http://ibm.biz/cluster-master-health'", "type": "string", "x-go-name": "MasterHealth", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterState": { "description": "The lifecycle state of the cluster master. Possible values include deployed, deploying, deploy_failed, deleting, delete_failed, updating, update_cancelled, and update_failed. For more information, see the docs 'http://ibm.biz/cluster-master-health'", "type": "string", "x-go-name": "MasterState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatus": { "type": "string", "x-go-name": "MasterStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatusModifiedDate": { "type": "string", "x-go-name": "MasterStatusModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "modifiedDate": { "type": "string", "x-go-name": "ModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "CommonClusterServiceEndpoint": { "type": "object", "title": "CommonClusterServiceEndpoint provides information about the service endpoint state of a cluster.", "properties": { "privateServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PrivateServiceEndpointEnabled" }, "privateServiceEndpointURL": { "type": "string", "x-go-name": "PrivateServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PublicServiceEndpointEnabled" }, "publicServiceEndpointURL": { "type": "string", "x-go-name": "PublicServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "CommonCreateCluster": { "type": "object", "title": "CommonCreateCluster contains the fields common to all requests to create clusters.", "properties": { "cseACLEnabled": { "type": "boolean", "x-go-name": "CSEACLEnabled" }, "defaultWorkerPoolEntitlement": { "type": "string", "x-go-name": "DefaultWorkerPoolEntitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disablePublicServiceEndpoint": { "type": "boolean", "x-go-name": "DisablePublicServiceEndpoint" }, "kubeVersion": { "type": "string", "x-go-name": "KubeVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "requestSecure": { "type": "boolean", "x-go-name": "RequestSecure" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CommonCreateClusterWorkerPool": { "description": "CommonCreateClusterWorkerPool contains the fields common to the worker pool part\nof all create cluster requests.", "type": "object", "properties": { "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CommonCreateClusterWorkerPoolZone": { "description": "CommonCreateClusterWorkerPoolZone contains the fields common to the worker pool\nzone part of all create cluster requests.", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CommonCreateWorkerPool": { "type": "object", "title": "CommonCreateWorkerPool contains the fields common to all requests to create worker pools.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CommonCreateWorkerPoolZone": { "description": "CommonCreateWorkerPoolZone contains the fields common to the zones part\nof classic create worker pool requests.", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CommonWorkerPoolZoneAdd": { "description": "CommonWorkerPoolZoneAdd is the common part of the createWorkerPoolZone request", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ComponentStatus": { "description": "ComponentStatus status of individual ingress component", "type": "object", "properties": { "component": { "type": "string", "x-go-name": "Component", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress-status" }, "ConfigAttributes": { "description": "ConfigAttributes defines attributes related to storage configuration", "type": "object", "properties": { "offering-type": { "type": "string", "x-go-name": "OfferingType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storageclasses": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "StorageClasses", "minItems": 0, "maxItems": 100 }, "supported-ocp-versions": { "type": "string", "x-go-name": "SupportedOcpVersions", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-availability": { "type": "string", "x-go-name": "VolumeAvailability", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-encryption-at-rest": { "type": "string", "x-go-name": "VolumeEncryptionAtRest", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-expansion": { "type": "string", "x-go-name": "VolumeExpansion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-snapshot": { "type": "string", "x-go-name": "VolumeSnapshot", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-type": { "type": "string", "x-go-name": "VolumeType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "ConfigMapKeySelector": { "description": "+structType=atomic", "type": "object", "title": "Selects a key from a ConfigMap.", "properties": { "key": { "description": "The key to select.", "type": "string", "x-go-name": "Key", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined\n+optional", "type": "boolean", "x-go-name": "Optional" } }, "x-go-package": "k8s.io/api/core/v1" }, "ConfigSubscriptionInfo": { "description": "ConfigSubscriptionInfo contains the details of subscription to be shows as part of a storage config get or list response", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterName": { "type": "string", "x-go-name": "ClusterName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "created": { "type": "string", "x-go-name": "Created", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "groups": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Groups", "minItems": 0, "maxItems": 100 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "rolloutStatus": { "type": "object", "properties": { "errorCount": { "type": "integer", "format": "int64", "x-go-name": "ErrorCount", "minimum": 0, "maximum": 2147483647 }, "successCount": { "type": "integer", "format": "int64", "x-go-name": "SuccessCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-name": "RolloutStatus" }, "subscriptionType": { "type": "string", "x-go-name": "SubscriptionType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Tags", "minItems": 0, "maxItems": 100 }, "updated": { "type": "string", "x-go-name": "Updated", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionUuid": { "type": "string", "x-go-name": "VersionUUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "CreateClusterRequest": { "type": "object", "title": "CreateClusterRequest is the payload sent by clients when creating a cluster.", "properties": { "cseACLEnabled": { "type": "boolean", "x-go-name": "CSEACLEnabled" }, "defaultWorkerPoolEntitlement": { "type": "string", "x-go-name": "DefaultWorkerPoolEntitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disablePublicServiceEndpoint": { "type": "boolean", "x-go-name": "DisablePublicServiceEndpoint" }, "kubeVersion": { "type": "string", "x-go-name": "KubeVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPool": { "$ref": "#/components/schemas/CreateClusterRequestWorkerPool" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "CreateClusterRequestWorkerPool": { "description": "CreateClusterRequestWorkerPool provides the worker properties of the VPC cluster to be\ncreated.", "type": "object", "properties": { "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPool": { "type": "string", "x-go-name": "HostPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/Zone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "CreateClusterResponse": { "type": "object", "title": "CreateClusterResponse is data returned by a ClusterCreate request call.", "properties": { "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UserMessage" }, "x-go-name": "Messages", "minItems": 0, "maxItems": 100 }, "non_critical_errors": { "$ref": "#/components/schemas/ResponseErrors" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "CreateConfig": { "description": "CreateConfig the secret create request", "type": "object", "properties": { "add": { "type": "array", "items": { "$ref": "#/components/schemas/FieldAdd" }, "x-go-name": "FieldsToAdd", "minItems": 0, "maxItems": 100 }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "persistence": { "type": "boolean", "x-go-name": "Persistence" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret" }, "CreateConfigurationData": { "description": "CreateConfigurationData - a single return struct", "type": "object", "properties": { "addChannel": { "type": "object", "properties": { "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "AddChannel" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "CreateCredentialReq": { "description": "CreateCredentialReq is the request body for setting credentials for an external DNS provider", "type": "object", "properties": { "akamai_credentials": { "$ref": "#/components/schemas/AkamaiCredentials" }, "cloudflare_credentials": { "$ref": "#/components/schemas/CloudflareCredentials" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "CreateDedicatedHost": { "type": "object", "title": "CreateDedicatedHost contains the fields in requests to create dedicated host instances.", "properties": { "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPoolID": { "type": "string", "x-go-name": "HostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CreateDedicatedHostPool": { "type": "object", "title": "CreateDedicatedHostPool contains the fields in requests to create dedicated host pool instances.", "properties": { "flavorClass": { "type": "string", "x-go-name": "FlavorClass", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "metro": { "type": "string", "x-go-name": "Metro", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "CreateDedicatedHostPoolResponse": { "type": "object", "title": "CreateDedicatedHostPool is a response to a dedicated host pool create request.", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "CreateDedicatedHostPool", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "CreateDedicatedHostResponse": { "type": "object", "title": "CreateDedicatedHost is a response to a dedicated host create request.", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "CreateDedicatedHost", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "CreateDomainReq": { "description": "CreateDomainReq request body for creating domain", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostname": { "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ips": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IPs", "minItems": 0, "maxItems": 100 }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretNamespace": { "type": "string", "x-go-name": "SecretNamespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zoneID": { "type": "string", "x-go-name": "ZoneID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "CreateDomainResponse": { "description": "CreateDomainResponse return model for creating a new domain", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domain": { "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostname": { "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ips": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IPs", "minItems": 0, "maxItems": 100 }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretNamespace": { "type": "string", "x-go-name": "SecretNamespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "CreateSubscriptionByClusterInputData": { "type": "object", "title": "CreateSubscriptionByClusterInputData ...", "properties": { "autoUpgrade": { "type": "string", "x-go-name": "AutoUpgrade", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "config": { "type": "string", "x-go-name": "Config", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "CreateSubscriptionData": { "type": "object", "title": "CreateSubscriptionData ...", "properties": { "addSubscription": { "$ref": "#/components/schemas/AddSubscriptionType" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "CreateSubscriptionInputData": { "type": "object", "title": "CreateSubscriptionInputData ...", "properties": { "autoUpgrade": { "type": "string", "x-go-name": "AutoUpgrade", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "config": { "type": "string", "x-go-name": "Config", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "groups": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Groups", "minItems": 0, "maxItems": 100 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "CreateWorkerpoolRequest": { "type": "object", "title": "CreateWorkerpoolRequest defines a request to create workerpool.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPool": { "type": "string", "x-go-name": "HostPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/Zone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "CreateWorkerpoolResponse": { "type": "object", "title": "CreateWorkerpoolResponse is data returned by a create workerpool request call.", "properties": { "workerPoolID": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "CreateWorkerpoolZoneRequest": { "type": "object", "title": "CreateWorkerpoolZoneRequest defines a request to add zones to a worker pool.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "CredentialReq": { "description": "CredentialReq is the request body for setting and deleting the access credentials\nfor the cluster's DNS provider", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "Credentials": { "description": "Credentials provides information about user infrastructure credentials", "type": "object", "properties": { "apiUser": { "type": "string", "x-go-name": "APIUser", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "CustomParameter": { "type": "object", "title": "CustomParameter ...", "properties": { "Validator": { "$ref": "#/components/schemas/Validator" }, "category": { "type": "string", "x-go-name": "Category", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "default": { "type": "string", "x-go-name": "Default", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "displayname": { "type": "string", "x-go-name": "DisplayName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "max-length": { "type": "integer", "format": "int64", "x-go-name": "MaxLength", "minimum": 0, "maximum": 2147483647 }, "min-length": { "type": "integer", "format": "int64", "x-go-name": "MinLength", "minimum": 0, "maximum": 2147483647 }, "mutable": { "type": "string", "x-go-name": "Mutable", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "obfuscate": { "type": "string", "x-go-name": "Obfuscate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "place-holder": { "type": "string", "x-go-name": "PlaceHolder", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "regex": { "type": "string", "x-go-name": "RegEx", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "regexFlags": { "type": "string", "x-go-name": "RegExFlags", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "required": { "type": "string", "x-go-name": "Required", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supported-values": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedValues", "minItems": 0, "maxItems": 100 }, "templateKeyName": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "TemplateKeyName", "minItems": 0, "maxItems": 100 }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "DataCenter": { "description": "DataCenter properties", "type": "object", "properties": { "location": { "description": "The location of the data center.", "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "DedicatedConfig": { "description": "DedicatedConfig represents a dedicated configuration with domain and DNS info", "type": "object", "properties": { "dnsIp": { "description": "The PowerDNS IP address of the IBM Cloud Dedicated environment.", "type": "string", "x-go-name": "DNSIP", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domain": { "description": "The domain name of the IBM Cloud Dedicated environment.", "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "DedicatedConfigDNSServers": { "description": "DedicatedConfigDNSServers - replaces old dedicated config on dedicated GA", "type": "object", "properties": { "dnsservers": { "description": "A list of DNS servers that are used for IBM Cloud Dedicated environments.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minItems": 0, "maxItems": 100 }, "x-go-name": "DNSServers" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "DedicatedHostLifecycle": { "type": "object", "title": "DedicatedHostLifecycle contains dedicated host lifecycle data as part of a GetDedicatedHost response.", "properties": { "actualState": { "type": "string", "x-go-name": "ActualState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredState": { "type": "string", "x-go-name": "DesiredState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messageDate": { "type": "string", "x-go-name": "MessageDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messageDetails": { "type": "string", "x-go-name": "MessageDetails", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messageDetailsDate": { "type": "string", "x-go-name": "MessageDetailsDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "DedicatedHostPoolWorkerPool": { "type": "object", "title": "DedicatedHostPoolWorkerPool contains a dedicated host pool's cluster details as part of a GetDedicatedHostPool response.", "properties": { "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPoolID": { "type": "string", "x-go-name": "WorkerPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "DedicatedHostResource": { "type": "object", "title": "DedicatedHostResource contains dedicated host capacity and consumption details for a specific VM as part of a GetDedicatedHost response.", "properties": { "memoryBytes": { "type": "integer", "format": "uint64", "x-go-name": "MemoryBytes", "minimum": 0, "maximum": 2147483647 }, "vcpu": { "type": "integer", "format": "int64", "x-go-name": "VCPU", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "DedicatedHostResources": { "type": "object", "title": "DedicatedHostResources contains dedicated host capacity and consumption details for multiple VMs as part of a GetDedicatedHost response.", "properties": { "capacity": { "$ref": "#/components/schemas/DedicatedHostResource" }, "consumed": { "$ref": "#/components/schemas/DedicatedHostResource" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "DedicatedHostWorker": { "type": "object", "title": "DedicatedHostWorker contains dedicated host cluster details as part of a GetDedicatedHost response.", "properties": { "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerID": { "type": "string", "x-go-name": "WorkerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPoolID": { "type": "string", "x-go-name": "WorkerPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "DedicatedHostZoneResources": { "type": "object", "title": "DedicatedHostZoneResources contains a dedicated host pool's zone capacity details as part of a GetDedicatedHostPool response.", "properties": { "capacity": { "$ref": "#/components/schemas/DedicatedHostResource" }, "hostCount": { "type": "integer", "format": "int64", "x-go-name": "HostCount", "minimum": 0, "maximum": 2147483647 }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "DefaultLoggingEndpointResponse": { "description": "DefaultLoggingEndpointResponse is the ibm logging service endpoint where logs will be sent by default clusters in the target region", "type": "object", "properties": { "endpoint": { "description": "The IBM Cloud Log Analysis with LogDNA API endpoint that the hostname uses.", "type": "string", "x-go-name": "Endpoint", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostname": { "description": "The hostname for the ibm logging service.", "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "port": { "description": "The port for the ibm logging service.", "type": "integer", "format": "int64", "x-go-name": "Port", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "DeleteConfig": { "description": "DeleteConfig the secret delete request", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "delete_cert": { "type": "boolean", "x-go-name": "DeleteCert" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret" }, "DeleteDedicatedHost": { "type": "object", "title": "DeleteDedicatedHost contains the fields in requests to delete dedicated host instances.", "properties": { "host": { "type": "string", "x-go-name": "Host", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPool": { "type": "string", "x-go-name": "HostPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "DeleteDomainReq": { "description": "DeleteDomainReq is the request body for deleting a domain from cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subdomain": { "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "Deployments": { "description": "Deployments reports status of deployments on the IBM Cloud Satellite location", "type": "object", "properties": { "enabled": { "description": "Value is true when the location is ready to deploy new clusters", "type": "boolean", "x-go-name": "Enabled" }, "message": { "description": "Contains troubleshooting messages when the location is not able to deploy a cluster", "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "DesiredAttributes": { "description": "DesiredAttributes are various attributes associated with a particular storage request", "type": "object", "properties": { "max-volume-size": { "type": "string", "x-go-name": "MaxVolumeSize", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering-type": { "type": "string", "x-go-name": "OfferingType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storageclasses": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "StorageClasses", "minItems": 0, "maxItems": 100 }, "total-capacity": { "type": "string", "x-go-name": "TotalCapacity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-availability": { "type": "string", "x-go-name": "VolumeAvailability", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-encryption-at-rest": { "type": "string", "x-go-name": "VolumeEncryptionAtRest", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-expansion": { "type": "string", "x-go-name": "VolumeExpansion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-snapshot": { "type": "string", "x-go-name": "VolumeSnapshot", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-type": { "type": "string", "x-go-name": "VolumeType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "DetailedHealthIssue": { "type": "object", "title": "Structure used in a getIssue API response.", "properties": { "component": { "type": "string", "x-go-name": "Component", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "detected": { "type": "string", "x-go-name": "Detected", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "more_details": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkHealthMoreDetails" }, "x-go-name": "MoreDetails", "minItems": 0, "maxItems": 100 }, "severity": { "type": "string", "x-go-name": "Severity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "solution": { "type": "string", "x-go-name": "Solution", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "_DetailedHealthIssue", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "Device": { "type": "object", "title": "Device ...", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/vpc" }, "DisablePodSecurityPolicyRequest": { "description": "DisablePodSecurityPolicyRequest disables the cluster PodSecurityPolicy admission controller for v1.24 clusters", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "DiskConfigResp": { "description": "DiskConfigResp response type for describing a disk configuration", "type": "object", "properties": { "Count": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "DeviceType": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "RAIDConfiguration": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "Size": { "description": "the size of each individual device in GB", "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "profile": { "type": "string", "x-go-name": "Profile", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "Duration": { "description": "A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.", "type": "integer", "format": "int64", "x-go-package": "time", "minimum": 0, "maximum": 2147483647 }, "EnableKMSRequest": { "description": "EnableKMSRequest defines the payload required to enable KMS on a given cluster", "type": "object", "properties": { "account_id": { "type": "string", "x-go-name": "AccountID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crk_id": { "type": "string", "x-go-name": "CRKID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "instance_id": { "type": "string", "x-go-name": "InstanceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "private_endpoint": { "type": "boolean", "x-go-name": "PrivateEndpoint" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "EnablePodSecurityPolicyRequest": { "description": "EnablePodSecurityPolicyRequest enables the cluster PodSecurityPolicy admission controller for v1.24 clusters", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "EnablePullSecret": { "description": "EnablePullSecret contains an enable pull secret request for a cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "EnableSecureByDefaultClusterRequest": { "type": "object", "title": "EnableSecureByDefaultClusterRequest defines a request to take a non-Secure By Default cluster and enable it to follow the Secure By Default Security Group model.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableOutboundTrafficProtection": { "type": "boolean", "x-go-name": "DisableOutboundTrafficProtection" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "EnvVar": { "type": "object", "title": "EnvVar represents an environment variable present in a Container.", "properties": { "name": { "description": "Name of the environment variable.\nMay consist of any printable ASCII characters except '='.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "value": { "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional", "type": "string", "x-go-name": "Value", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "valueFrom": { "$ref": "#/components/schemas/EnvVarSource" } }, "x-go-package": "k8s.io/api/core/v1" }, "EnvVarSource": { "type": "object", "title": "EnvVarSource represents a source for the value of an EnvVar.", "properties": { "configMapKeyRef": { "$ref": "#/components/schemas/ConfigMapKeySelector" }, "fieldRef": { "$ref": "#/components/schemas/ObjectFieldSelector" }, "fileKeyRef": { "$ref": "#/components/schemas/FileKeySelector" }, "resourceFieldRef": { "$ref": "#/components/schemas/ResourceFieldSelector" }, "secretKeyRef": { "$ref": "#/components/schemas/SecretKeySelector" } }, "x-go-package": "k8s.io/api/core/v1" }, "ErrorBase": { "type": "object", "properties": { "code": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "x-go-name": "Err", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "recoveryCLI": { "type": "string", "x-go-name": "RecoveryCLI", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "terseDescription": { "type": "string", "x-go-name": "TerseErr", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "$ref": "#/components/schemas/ErrorType" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/errors" }, "ErrorResponse": { "description": "ErrorResponse error response to end users", "type": "object", "properties": { "code": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "x-go-name": "Err", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "incidentID": { "type": "string", "x-go-name": "ReqID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "recoveryCLI": { "type": "string", "x-go-name": "RecoveryCLI", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "terseDescription": { "type": "string", "x-go-name": "TerseErr", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "$ref": "#/components/schemas/ErrorType" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/errors" }, "ErrorType": { "description": "ErrorType error type", "type": "string", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/errors", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ExpandDesiredStorageCapacityRequest": { "description": "ExpandDesiredStorageCapacityRequest is the request body for expandDesiredStorageConfigCapacity API", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "request-id": { "type": "string", "x-go-name": "RequestID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "total-capacity": { "type": "string", "x-go-name": "TotalCapacity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "ExtendedNlbVPCConfig": { "description": "ExtendedNlbVPCConfig is the response body for the get v2 vpc apis", "type": "object", "properties": { "certProvider": { "type": "string", "x-go-name": "CertProvider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dnsType": { "type": "string", "x-go-name": "DNSType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "lbHostname": { "type": "string", "x-go-name": "LBHostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbIPArray": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "NlbIPArray", "minItems": 0, "maxItems": 100 }, "nlbSubdomain": { "type": "string", "x-go-name": "NlbSubdomain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretNamespace": { "type": "string", "x-go-name": "SecretNamespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "statusMessage": { "type": "string", "x-go-name": "StatusMessage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zoneID": { "type": "string", "x-go-name": "ZoneID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/vpc" }, "Field": { "description": "Field struct holding details for a single secret field", "type": "object", "properties": { "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "expiresOn": { "type": "string", "x-go-name": "ExpiresOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "lastUpdatedTimestamp": { "type": "string", "x-go-name": "LastUpdatedTimestamp", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretType": { "type": "string", "x-go-name": "SecretType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret" }, "FieldAdd": { "description": "FieldAdd the secret field add request", "type": "object", "properties": { "append_prefix": { "type": "boolean", "x-go-name": "AppendPrefix" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret" }, "FieldRemove": { "description": "FieldRemove the secret field remove request", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret" }, "Fields": { "description": "Fields struct for a secret array", "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret", "minItems": 0, "maxItems": 100 }, "FileKeySelector": { "description": "+structType=atomic", "type": "object", "title": "FileKeySelector selects a key of the env file.", "properties": { "key": { "description": "The key within the env file. An invalid key will prevent the pod from starting.\nThe keys defined within a source may consist of any printable ASCII characters except '='.\nDuring Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.\n+required", "type": "string", "x-go-name": "Key", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "optional": { "description": "Specify whether the file or its key must be defined. If the file or key\ndoes not exist, then the env var is not published.\nIf optional is set to true and the specified key does not exist,\nthe environment variable will not be set in the Pod's containers.\n\nIf optional is set to false and the specified key does not exist,\nan error will be returned during Pod creation.\n+optional\n+default=false", "type": "boolean", "x-go-name": "Optional" }, "path": { "description": "The path within the volume from which to select the file.\nMust be relative and may not contain the '..' path or start with '..'.\n+required", "type": "string", "x-go-name": "Path", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volumeName": { "description": "The name of the volume mount containing the env file.\n+required", "type": "string", "x-go-name": "VolumeName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "k8s.io/api/core/v1" }, "FilterConfig": { "type": "object", "title": "FilterConfig stores a logging filter configuration.", "properties": { "container": { "description": "The name of the container that you want to exclude from your logs.", "type": "string", "x-go-name": "Container", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "description": "The unique identifier of the logging configuration.", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "label": { "description": "The pod label that you want to exclude from your logs.", "type": "string", "x-go-name": "Label", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logLevel": { "description": "The log level that you want to apply to your logs. Supported values are `debug` or `info`.", "type": "string", "x-go-name": "LogLevel", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "loggingConfigs": { "description": "A list of logging configuration IDs where you want to apply the log filter.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "LoggingConfigs", "minItems": 0, "maxItems": 100 }, "message": { "description": "A string in a log message that you want to exclude from your logs.", "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "description": "The Kubernetes namespace that you want to exclude from your logs.", "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "regexMessageEnabled": { "description": "Set this value to `true` if you want to interpret the message field as a regular expression.", "type": "boolean", "x-go-name": "RegexMessageEnabled" }, "type": { "description": "The type of filter that you want to apply to your logs. Supported values are `container` and `non-container`.", "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "description": "Internal use only.", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "FilterConfigBody": { "description": "FilterConfigBody is how users will interact with the logging endpoints", "type": "object", "properties": { "container": { "description": "The name of the container where you want to apply the logging filter.", "type": "string", "x-go-name": "Container", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logLevel": { "description": "The log level that you want to apply to your logging filter.", "type": "string", "x-go-name": "LogLevel", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "loggingConfigs": { "description": "A list of logging configuration IDs where you want to apply the logging filter.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "LoggingConfigs", "minItems": 0, "maxItems": 100 }, "message": { "description": "A string in a message to which you want to apply the logging filter.", "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "description": "The Kubernetes namespace where you want to apply the logging filter.", "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "regexMessageEnabled": { "description": "Set this value to `true` if you want the message field to be interpreted as a regular expression.", "type": "boolean", "x-go-name": "RegexMessageEnabled" }, "type": { "description": "The type of the logging filter.", "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "FilterConfigResponse": { "description": "FilterConfigResponse is how users will see their logging filter configs from API responses", "type": "object", "properties": { "container": { "description": "The name of the container that you want to exclude from your logs.", "type": "string", "x-go-name": "Container", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "coveringFilters": { "description": "A list of logging filter IDs that the filter covers.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "CoveringFilters", "minItems": 0, "maxItems": 100 }, "id": { "description": "The unique identifier of the logging configuration.", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "label": { "description": "The pod label that you want to exclude from your logs.", "type": "string", "x-go-name": "Label", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logLevel": { "description": "The log level that you want to apply to your logs. Supported values are `debug` or `info`.", "type": "string", "x-go-name": "LogLevel", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "loggingConfigs": { "description": "A list of logging configuration IDs where you want to apply the log filter.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "LoggingConfigs", "minItems": 0, "maxItems": 100 }, "message": { "description": "A string in a log message that you want to exclude from your logs.", "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "description": "The Kubernetes namespace that you want to exclude from your logs.", "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "regexMessageEnabled": { "description": "Set this value to `true` if you want to interpret the message field as a regular expression.", "type": "boolean", "x-go-name": "RegexMessageEnabled" }, "type": { "description": "The type of filter that you want to apply to your logs. Supported values are `container` and `non-container`.", "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "description": "Internal use only.", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "Flavor": { "description": "Flavor Definition of a flavor / machine type that can be deployed", "type": "object", "properties": { "architecture": { "description": "The type of CPU architecture that the flavor uses.", "type": "string", "x-go-name": "Architecture", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "correspondingFlavor": { "type": "string", "x-go-name": "CorrespondingFlavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "id": { "description": "The ID of the worker node flavor.", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isTrusted": { "type": "boolean", "x-go-name": "IsTrusted" }, "name": { "description": "The name of the worker node flavor.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "description": "The name of the provider.", "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorage": { "type": "string", "x-go-name": "SecondaryStorage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageEncrypted": { "type": "boolean", "x-go-name": "SecondaryStorageEncrypted" }, "storage": { "type": "string", "x-go-name": "Storage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "FlavorResponse": { "description": "FlavorResponse response type for retrieving a flavor", "type": "object", "properties": { "additionalStorage": { "type": "array", "items": { "$ref": "#/components/schemas/DiskConfigResp" }, "x-go-name": "AdditionalStorage", "minItems": 0, "maxItems": 100 }, "architecture": { "type": "string", "x-go-name": "Architecture", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cores": { "type": "integer", "format": "int64", "x-go-name": "Cores", "minimum": 0, "maximum": 2147483647 }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "flavor_class": { "type": "string", "x-go-name": "FlavorClass", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "gpus": { "type": "array", "items": { "$ref": "#/components/schemas/GPUConfigResp" }, "x-go-name": "GPUs", "minItems": 0, "maxItems": 100 }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "memory": { "type": "string", "x-go-name": "Memory", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkSpeed": { "type": "string", "x-go-name": "NetworkSpeed", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ocp_unsupported": { "type": "boolean", "x-go-name": "OCPUnsupported" }, "os": { "type": "string", "x-go-name": "OS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "primaryStorage": { "$ref": "#/components/schemas/DiskConfigResp" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorage": { "$ref": "#/components/schemas/DiskConfigResp" }, "secondaryStorageEncrypted": { "type": "boolean", "x-go-name": "SecondaryStorageEncrypted" }, "secondaryStorageOptions": { "type": "array", "items": { "$ref": "#/components/schemas/DiskConfigResp" }, "x-go-name": "SecondaryStorageOptions", "minItems": 0, "maxItems": 100 }, "serverType": { "type": "string", "x-go-name": "ServerType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "sgxEnabled": { "type": "boolean", "x-go-name": "SGXEnabled" }, "supportedOperatingSystems": { "$ref": "#/components/schemas/SupportedOperatingSystems" }, "supported_isolation": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedIsolation", "minItems": 0, "maxItems": 100 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Tags", "minItems": 0, "maxItems": 100 }, "vcpus": { "type": "integer", "format": "int64", "x-go-name": "VCPUs", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GCPCredential": { "description": "GCPCredential required to communicate with Google Cloud Platform", "type": "object", "properties": { "auth_provider_x509_cert_url": { "type": "string", "x-go-name": "AuthProviderCertURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "auth_uri": { "type": "string", "x-go-name": "AuthURI", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client_email": { "type": "string", "x-go-name": "ClientEmail", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client_id": { "type": "string", "x-go-name": "ClientID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "client_x509_cert_url": { "type": "string", "x-go-name": "ClientCertURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "private_key": { "type": "string", "x-go-name": "PrivateKey", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "private_key_id": { "type": "string", "x-go-name": "PrivateKeyID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "project_id": { "type": "string", "x-go-name": "ProjectID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "token_uri": { "type": "string", "x-go-name": "TokenURI", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/multishift" }, "GPUConfigResp": { "description": "GPUConfigResp response type for describing a GPU configuration", "type": "object", "properties": { "Count": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "Type": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GenericCluster": { "description": "Cluster properties", "type": "object", "properties": { "addons": { "type": "array", "items": { "$ref": "#/components/schemas/Addon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "apiUser": { "type": "string", "x-go-name": "APIUser", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultProvider": { "type": "string", "x-go-name": "DefaultProvider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultZone": { "type": "string", "x-go-name": "DefaultZone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredTrustedProfileID": { "type": "string", "x-go-name": "DesiredTrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "etcdPort": { "type": "string", "x-go-name": "EtcdPort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ignitionServerURL": { "type": "string", "x-go-name": "IgnitionServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "imageSecurityEnabled": { "type": "boolean", "x-go-name": "ImageSecurityEnabled" }, "ingressHostname": { "type": "string", "x-go-name": "IngressHostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressMessage": { "type": "string", "x-go-name": "IngressMessage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressSecretName": { "type": "string", "x-go-name": "IngressSecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressStatus": { "type": "string", "x-go-name": "IngressStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "keyProtectEnabled": { "type": "boolean", "x-go-name": "KeyProtectEnabled" }, "konnectivityServerURL": { "type": "string", "x-go-name": "KonnectivityServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logOrg": { "type": "string", "x-go-name": "OrgID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logOrgName": { "type": "string", "x-go-name": "OrgName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSpace": { "type": "string", "x-go-name": "SpaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSpaceName": { "type": "string", "x-go-name": "SpaceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterHealth": { "type": "string", "x-go-name": "MasterHealth", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterKubeVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterState": { "type": "string", "x-go-name": "MasterState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatus": { "type": "string", "x-go-name": "MasterStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterStatusModifiedDate": { "type": "string", "x-go-name": "MasterStatusModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "modifiedDate": { "type": "string", "x-go-name": "ModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "monitoringURL": { "type": "string", "x-go-name": "MonitoringURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "oauthServerURL": { "type": "string", "x-go-name": "OauthServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnets": { "type": "string", "x-go-name": "PodSubnets", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PrivateServiceEndpointEnabled" }, "privateServiceEndpointURL": { "type": "string", "x-go-name": "PrivateServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicServiceEndpointEnabled": { "type": "boolean", "x-go-name": "PublicServiceEndpointEnabled" }, "publicServiceEndpointURL": { "type": "string", "x-go-name": "PublicServiceEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pullSecretApplied": { "type": "boolean", "x-go-name": "PullSecretApplied" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serverURL": { "type": "string", "x-go-name": "ServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnets": { "type": "array", "items": { "$ref": "#/components/schemas/GenericSubnet" }, "x-go-name": "Subnets", "minItems": 0, "maxItems": 100 }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcNativeRoutingEnabled": { "type": "boolean", "x-go-name": "VPCNativeRoutingEnabled" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-name": "Cluster", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "GenericClusterConfig": { "description": "ClusterConfig config needed to create a cluster for API", "type": "object", "properties": { "defaultWorkerPoolName": { "type": "string", "x-go-name": "DefaultWorkerPoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultZone": { "type": "string", "x-go-name": "DefaultZone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "noSubnet": { "type": "boolean", "x-go-name": "NoSubnet" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnets": { "type": "string", "x-go-name": "PodSubnets", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "prefix": { "type": "string", "x-go-name": "Prefix", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "skipPermPrecheck": { "type": "boolean", "x-go-name": "SkipPermissionPrecheck" }, "subnets": { "type": "array", "items": { "$ref": "#/components/schemas/GenericWorkerSubnetConfig" }, "x-go-name": "Subnets", "minItems": 0, "maxItems": 100 }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcNativeRoutingEnabled": { "type": "boolean", "x-go-name": "VPCNativeRoutingEnabled" }, "workerNum": { "type": "integer", "format": "int64", "x-go-name": "WorkerNum", "minimum": 0, "maximum": 2147483647 }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "ClusterConfig", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "GenericSubnet": { "description": "Subnet used for API", "type": "object", "properties": { "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "gateway": { "type": "string", "x-go-name": "Gateway", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ipv4_cidr_block": { "type": "string", "x-go-name": "CIDR", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "Subnet", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "GenericWorker": { "description": "Worker properties", "type": "object", "properties": { "errorMessage": { "type": "string", "x-go-name": "ErrorMessage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "errorMessageDate": { "type": "string", "x-go-name": "ErrorMessageDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "type": "string", "x-go-name": "WorkerVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterVersionEOS": { "type": "string", "x-go-name": "MasterEOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pendingOperation": { "type": "string", "x-go-name": "PendingOperation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolid": { "type": "string", "x-go-name": "PoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reasonForDelete": { "type": "string", "x-go-name": "ReasonForDelete", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "statusDate": { "type": "string", "x-go-name": "StatusDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "statusDetails": { "type": "string", "x-go-name": "StatusDetails", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnets": { "$ref": "#/components/schemas/WorkerSubnets" }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedStatus": { "type": "string", "x-go-name": "TrustedStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "Worker", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "GenericWorkerConfig": { "description": "WorkerConfig used for CreateCluster API", "type": "object", "properties": { "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "prefix": { "type": "string", "x-go-name": "Prefix", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnets": { "type": "array", "items": { "$ref": "#/components/schemas/GenericWorkerSubnetConfig" }, "x-go-name": "Subnets", "minItems": 0, "maxItems": 100 }, "workerNum": { "type": "integer", "format": "int64", "x-go-name": "WorkerNum", "minimum": 0, "maximum": 2147483647 }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "WorkerConfig", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "GenericWorkerSubnet": { "description": "WorkerSubnet used for API", "type": "object", "properties": { "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "gateway": { "type": "string", "x-go-name": "Gateway", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ipv4_addresses": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IPv4Addresses", "minItems": 0, "maxItems": 100 }, "ipv4_cidr_block": { "type": "string", "x-go-name": "CIDR", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "WorkerSubnet", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "GenericWorkerSubnetConfig": { "description": "WorkerSubnetConfig used for API", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "WorkerSubnetConfig", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "GetCRKResponse": { "description": "GetCRKResponse is data returned by a getCRKs request call", "type": "object", "properties": { "crk_id": { "type": "string", "x-go-name": "CRKID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "keyRingID": { "type": "string", "x-go-name": "KeyRingID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "GetClassicWorkerPoolResponse": { "type": "object", "title": "GetWorkerPoolResponse is data returned by a GetWorkerPool request call.", "properties": { "autoscaleEnabled": { "type": "boolean", "x-go-name": "AutoscaleEnabled" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavorState": { "type": "string", "x-go-name": "FlavorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isBalanced": { "type": "boolean", "x-go-name": "IsBalanced" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerPoolResponseLifecycle" }, "openshiftLicense": { "type": "string", "x-go-name": "OpenShiftLicenseSource", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reservationID": { "type": "string", "x-go-name": "ReservationID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reservationName": { "type": "string", "x-go-name": "ReservationName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "taints": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Taints" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkersPerZone", "minimum": 0, "maximum": 2147483647 }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerPoolZoneResponse" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-name": "GetWorkerPoolResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "GetClassicWorkerResponse": { "type": "object", "title": "GetWorkerResponse is data returned by a GetWorker request call.", "properties": { "dedicatedHostId": { "type": "string", "x-go-name": "DedicatedHostID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "health": { "$ref": "#/components/schemas/GetWorkerResponseHealth" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "$ref": "#/components/schemas/GetWorkerResponseKubeVersion" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerResponseLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkInformation": { "$ref": "#/components/schemas/GetWorkerResponseNetworkInformation" }, "poolID": { "type": "string", "x-go-name": "PoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "GetWorkerResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "GetClassicWorkersResponse": { "type": "array", "title": "GetWorkersResponse is data returned by a GetWorkers request call.", "items": { "$ref": "#/components/schemas/GetClassicWorkerResponse" }, "x-go-name": "GetWorkersResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic", "minItems": 0, "maxItems": 100 }, "GetClusterResponse": { "type": "object", "title": "GetClusterResponse is data returned by a GetCluster request call.", "properties": { "addons": { "type": "array", "items": { "$ref": "#/components/schemas/CommonClusterAddon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "caCertRotationStatus": { "$ref": "#/components/schemas/CommonClusterCACertRotation" }, "calicoIPAutodetectionConfig": { "type": "string", "x-go-name": "CalicoIPAutodetectionConfig", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "datacenter": { "type": "string", "x-go-name": "Datacenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredTrustedProfileID": { "type": "string", "x-go-name": "DesiredTrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "etcdPort": { "type": "string", "x-go-name": "EtcdPort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "features": { "$ref": "#/components/schemas/CommonClusterFeatures" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ignitionServerURL": { "type": "string", "x-go-name": "IgnitionServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "imageSecurityEnabled": { "type": "boolean", "x-go-name": "ImageSecurityEnabled" }, "infrastructureTopology": { "type": "string", "x-go-name": "InfrastructureTopology", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingress": { "$ref": "#/components/schemas/CommonClusterIngress" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "keyManagementService": { "$ref": "#/components/schemas/CommonClusterKMS" }, "konnectivityServerURL": { "type": "string", "x-go-name": "KonnectivityServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "lifecycle": { "$ref": "#/components/schemas/CommonClusterLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "locationEndpointURL": { "type": "string", "x-go-name": "LocationEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "locationZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "LocationZones", "minItems": 0, "maxItems": 100 }, "masterKubeVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterURL": { "type": "string", "x-go-name": "MasterURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multiAzCapable": { "type": "boolean", "x-go-name": "MultiAZCapable" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "oauthServerURL": { "type": "string", "x-go-name": "OauthServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "outboundTrafficProtection": { "type": "string", "x-go-name": "OutboundTrafficProtection", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "ProviderID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "satellitePrivateEndpointURL": { "type": "string", "x-go-name": "SatellitePrivateEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secureByDefault": { "type": "string", "x-go-name": "SecureByDefault", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secureRequested": { "type": "boolean", "x-go-name": "SecureRequested" }, "serviceEndpoints": { "$ref": "#/components/schemas/CommonClusterServiceEndpoint" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The lifecycle state of the cluster. Possible values include aborted, critical, delete_failed, deleted, deleting, deploy_failed, deploying, normal, pending, requested, updating, unsupported, and warning. For more information, see the docs 'http://ibm.biz/cluster-health-states'", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedOperatingSystems": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedOperatingSystems", "minItems": 0, "maxItems": 100 }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "virtualPrivateEndpointURL": { "type": "string", "x-go-name": "VirtualPrivateEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "VPCs", "minItems": 0, "maxItems": 100 }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "WorkerZones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/multishift" }, "GetClustersResponse": { "description": "GetClustersResponse cluster response for cluster list", "type": "object", "properties": { "addons": { "type": "array", "items": { "$ref": "#/components/schemas/CommonClusterAddon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "caCertRotationStatus": { "$ref": "#/components/schemas/CommonClusterCACertRotation" }, "calicoIPAutodetectionConfig": { "type": "string", "x-go-name": "CalicoIPAutodetectionConfig", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "datacenter": { "type": "string", "x-go-name": "Datacenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredTrustedProfileID": { "type": "string", "x-go-name": "DesiredTrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "etcdPort": { "type": "string", "x-go-name": "EtcdPort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "features": { "$ref": "#/components/schemas/CommonClusterFeatures" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "imageSecurityEnabled": { "type": "boolean", "x-go-name": "ImageSecurityEnabled" }, "ingress": { "$ref": "#/components/schemas/CommonClusterIngress" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "keyManagementService": { "$ref": "#/components/schemas/CommonClusterKMS" }, "lifecycle": { "$ref": "#/components/schemas/CommonClusterLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterKubeVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterURL": { "type": "string", "x-go-name": "MasterURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multiAzCapable": { "type": "boolean", "x-go-name": "MultiAZCapable" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "ProviderID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secureRequested": { "type": "boolean", "x-go-name": "SecureRequested" }, "serviceEndpoints": { "$ref": "#/components/schemas/CommonClusterServiceEndpoint" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The lifecycle state of the cluster. Possible values include aborted, critical, delete_failed, deleted, deleting, deploy_failed, deploying, normal, pending, requested, updating, unsupported, and warning. For more information, see the docs 'http://ibm.biz/cluster-health-states'", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GetCombinedWorkerPoolResponse": { "description": "getCombinedWorkerPoolResponse is a superset of all WorkerPool fields returned by all the v2\nget worker(s) operations, regardless of the provider.", "type": "object", "properties": { "autoscaleEnabled": { "type": "boolean", "x-go-name": "AutoscaleEnabled" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavorState": { "type": "string", "x-go-name": "FlavorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isBalanced": { "type": "boolean", "x-go-name": "IsBalanced" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerPoolResponseLifecycle" }, "openshiftLicense": { "type": "string", "x-go-name": "OpenshiftLicense", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reservationID": { "type": "string", "x-go-name": "ReservationID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reservationName": { "type": "string", "x-go-name": "ReservationName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageOption": { "$ref": "#/components/schemas/DiskConfigResp" }, "staticNetworkInterfaceCount": { "type": "integer", "format": "int64", "x-go-name": "StaticNetworkInterfaceCount", "minimum": 0, "maximum": 2147483647 }, "taints": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Taints" }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkersPerZone", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/GetWorkerPoolResponseZone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-name": "getCombinedWorkerPoolResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/combined" }, "GetCombinedWorkerResponse": { "type": "object", "title": "GetWorkerResponse is data returned by a GetWorkers request call.", "properties": { "dedicatedHostId": { "type": "string", "x-go-name": "DedicatedHostID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "health": { "$ref": "#/components/schemas/GetWorkerResponseHealth" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "$ref": "#/components/schemas/GetWorkerResponseKubeVersion" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerResponseLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkInformation": { "$ref": "#/components/schemas/GetWorkerResponseNetworkInformation" }, "networkInterfaces": { "$ref": "#/components/schemas/GetWorkerResponseNetworkInterfaces" }, "poolID": { "type": "string", "x-go-name": "PoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "GetWorkerResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/combined" }, "GetCredentials": { "description": "GetCredentials is the return model for a get on a credential", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "credID": { "type": "string", "x-go-name": "CredID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "expiresOn": { "type": "string", "x-go-name": "ExpiresOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "lastUpdatedTimestamp": { "type": "string", "x-go-name": "LastUpdatedTimeStamp", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "GetDedicatedHost": { "type": "object", "title": "GetDedicatedHost is a response to a dedicated host get request.", "properties": { "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "lifecycle": { "$ref": "#/components/schemas/DedicatedHostLifecycle" }, "placementEnabled": { "type": "boolean", "x-go-name": "PlacementEnabled" }, "resources": { "$ref": "#/components/schemas/DedicatedHostResources" }, "workers": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedHostWorker" }, "x-go-name": "Workers", "minItems": 0, "maxItems": 100 }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "GetDedicatedHostFlavor": { "type": "object", "title": "GetDedicatedHostFlavor is a response to a dedicated host pool get request.", "properties": { "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "flavorClass": { "type": "string", "x-go-name": "FlavorClass", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "instanceStorage": { "type": "array", "items": { "$ref": "#/components/schemas/InstanceStorage" }, "x-go-name": "InstanceStorage", "minItems": 0, "maxItems": 100 }, "maxMemory": { "type": "integer", "format": "int64", "x-go-name": "MaxMemory", "minimum": 0, "maximum": 2147483647 }, "maxVCPUs": { "type": "integer", "format": "int64", "x-go-name": "MaxVCPUs", "minimum": 0, "maximum": 2147483647 }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "GetDedicatedHostFlavors": { "type": "array", "title": "GetDedicatedHostFlavors is a response to a dedicated host pool list request.", "items": { "$ref": "#/components/schemas/GetDedicatedHostFlavor" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses", "minItems": 0, "maxItems": 100 }, "GetDedicatedHostPool": { "type": "object", "title": "GetDedicatedHostPool is a response to a dedicated host pool get request.", "properties": { "flavorClass": { "type": "string", "x-go-name": "FlavorClass", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostCount": { "type": "integer", "format": "int64", "x-go-name": "HostCount", "minimum": 0, "maximum": 2147483647 }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "metro": { "type": "string", "x-go-name": "Metro", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPools": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedHostPoolWorkerPool" }, "x-go-name": "WorkerPools", "minItems": 0, "maxItems": 100 }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedHostZoneResources" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "GetDedicatedHostPools": { "type": "array", "title": "GetDedicatedHostPools is a response to a dedicated host pool list request.", "items": { "$ref": "#/components/schemas/GetDedicatedHostPool" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses", "minItems": 0, "maxItems": 100 }, "GetDedicatedHosts": { "type": "array", "title": "GetDedicatedHosts is a response to a dedicated host list request.", "items": { "$ref": "#/components/schemas/GetDedicatedHost" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses", "minItems": 0, "maxItems": 100 }, "GetDesiredStorageConfigResponse": { "description": "GetDesiredStorageConfigResponse is the respose body for getDesiredStorageConfig API", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-requests": { "type": "array", "items": { "$ref": "#/components/schemas/StorageRequest" }, "x-go-name": "StorageRequests", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "GetKMSInstanceResponse": { "type": "object", "title": "GetKMSInstanceResponse is data returned by a GetKMSInstances request call.", "properties": { "instance_id": { "type": "string", "x-go-name": "InstanceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "service": { "type": "string", "x-go-name": "Service", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "GetQuota": { "description": "GetQuota defines a response when getting quota for an account", "type": "array", "items": { "$ref": "#/components/schemas/GetQuotaResource" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses", "minItems": 0, "maxItems": 100 }, "GetQuotaResource": { "type": "object", "title": "GetQuotaResource defines a quota resource type.", "properties": { "infrastructure": { "type": "string", "x-go-name": "Infrastructure", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/GetQuotaResourceRegion" }, "x-go-name": "Regions", "minItems": 0, "maxItems": 100 }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "GetQuotaResourceRegion": { "type": "object", "title": "GetQuotaResourceRegion defines a quota resource type region.", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "quota": { "type": "integer", "format": "int64", "x-go-name": "Quota", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "GetSecurityGroupsResponse": { "description": "GetSecurityGroupsResponse defines a response when getting list of security groups that are attached to the cluster", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "shared": { "type": "boolean", "x-go-name": "Shared" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "userProvided": { "type": "boolean", "x-go-name": "UserProvided" }, "workerPoolID": { "type": "string", "x-go-name": "WorkerPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "GetVPCResponse": { "description": "GetVPC defines a response when getting a VPC", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UserMessage" }, "x-go-name": "Messages", "minItems": 0, "maxItems": 100 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroup", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "GetVPC", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "GetVPCWorkerPoolResponse": { "type": "object", "title": "GetWorkerPoolResponse is data returned by a GetWorkerPool request call.", "properties": { "autoscaleEnabled": { "type": "boolean", "x-go-name": "AutoscaleEnabled" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavorState": { "type": "string", "x-go-name": "FlavorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isBalanced": { "type": "boolean", "x-go-name": "IsBalanced" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerPoolResponseLifecycle" }, "openshiftLicense": { "type": "string", "x-go-name": "OpenshiftLicense", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageOption": { "$ref": "#/components/schemas/DiskConfigResp" }, "staticNetworkInterfaceCount": { "type": "integer", "format": "int64", "x-go-name": "StaticNetworkInterfaceCount", "minimum": 0, "maximum": 2147483647 }, "taints": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Taints" }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkersPerZone", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/GetWorkerPoolResponseZone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-name": "GetWorkerPoolResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GetVPCWorkerResponse": { "type": "object", "title": "GetWorkerResponse is data returned by a GetWorker request call.", "properties": { "dedicatedHostId": { "type": "string", "x-go-name": "DedicatedHostID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "health": { "$ref": "#/components/schemas/GetWorkerResponseHealth" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "$ref": "#/components/schemas/GetWorkerResponseKubeVersion" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerResponseLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkInterfaces": { "$ref": "#/components/schemas/GetWorkerResponseNetworkInterfaces" }, "poolID": { "type": "string", "x-go-name": "PoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "GetWorkerResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GetVPCWorkersResponse": { "type": "array", "title": "GetWorkersResponse is data returned by a GetWorkers request call.", "items": { "$ref": "#/components/schemas/GetVPCWorkerResponse" }, "x-go-name": "GetWorkersResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc", "minItems": 0, "maxItems": 100 }, "GetWorkerPoolResponseLifecycle": { "type": "object", "title": "GetWorkerPoolResponseLifecycle provides information about the state of the workerpool.", "properties": { "actualState": { "type": "string", "x-go-name": "ActualState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredState": { "type": "string", "x-go-name": "DesiredState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "GetWorkerPoolResponseZone": { "description": "GetWorkerPoolResponseZone provides information about a zone belonging to the worker pool", "type": "object", "properties": { "autobalanceEnabled": { "type": "boolean", "x-go-name": "AutobalanceEnabled" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messages": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Messages", "minItems": 0, "maxItems": 100 }, "subnets": { "type": "array", "items": { "$ref": "#/components/schemas/GetWorkerPoolResponseZoneSubnet" }, "x-go-name": "Subnets", "minItems": 0, "maxItems": 100 }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GetWorkerPoolResponseZoneSubnet": { "description": "GetWorkerPoolResponseZoneSubnet provides information about a subnet in the worker pool's zone", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "primary": { "type": "boolean", "x-go-name": "Primary" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GetWorkerResponseHealth": { "type": "object", "title": "GetWorkerResponseHealth provides information about a worker's health.", "properties": { "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "GetWorkerResponseKubeVersion": { "type": "object", "title": "GetWorkerResponseKubeVersion provides information about the worker kubernetes version.", "properties": { "actual": { "type": "string", "x-go-name": "Actual", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desired": { "type": "string", "x-go-name": "Desired", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "eos": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterEOS": { "type": "string", "x-go-name": "MasterEOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "target": { "type": "string", "x-go-name": "Target", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "GetWorkerResponseLifecycle": { "type": "object", "title": "GetWorkerResponseLifecycle provides information about the state of the worker.", "properties": { "actualOperatingSystem": { "type": "string", "x-go-name": "ActualOperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "actualState": { "type": "string", "x-go-name": "ActualState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredOperatingSystem": { "type": "string", "x-go-name": "DesiredOperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredState": { "description": "Possible state values include critical, deployed, deploying, deploy_failed, normal, provisioning, provision_failed, reloading, reload_failed, reload_pending, unknown, and warning. For more information, see the docs 'http://ibm.biz/worker-health-state'", "type": "string", "x-go-name": "DesiredState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messageDate": { "type": "string", "x-go-name": "MessageDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messageDetails": { "type": "string", "x-go-name": "MessageDetails", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "messageDetailsDate": { "type": "string", "x-go-name": "MessageDetailsDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pendingOperation": { "type": "string", "x-go-name": "PendingOperation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reasonForDelete": { "type": "string", "x-go-name": "ReasonForDelete", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "GetWorkerResponseNetworkInformation": { "type": "object", "title": "GetWorkerResponseNetworkInformation provides classic-specific network information.", "properties": { "privateIP": { "type": "string", "x-go-name": "PrivateIP", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVLAN": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicIP": { "type": "string", "x-go-name": "PublicIP", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVLAN": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "GetWorkerResponseNetworkInterface": { "type": "object", "title": "GetWorkerResponseNetworkInterface represents a worker network interface.", "properties": { "cidr": { "type": "string", "x-go-name": "CIDR", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ipAddress": { "type": "string", "x-go-name": "IPAddress", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "primary": { "type": "boolean", "x-go-name": "Primary" }, "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "GetWorkerResponseNetworkInterfaces": { "type": "array", "title": "GetWorkerResponseNetworkInterfaces represents a list of worker network interfaces.", "items": { "$ref": "#/components/schemas/GetWorkerResponseNetworkInterface" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc", "minItems": 0, "maxItems": 100 }, "GetWorkersResponse": { "type": "array", "items": { "$ref": "#/components/schemas/GetCombinedWorkerResponse" }, "x-go-name": "getWorkersResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/combined", "minItems": 0, "maxItems": 100 }, "GlobalAddon": { "description": "GlobalAddon represents a Chief addon, including properties like the YAML definition, date, and if it is enabled", "type": "object", "properties": { "AddonName": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDCreateDate": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDEnabled": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDPathCreateDate": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDPathEnabled": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDPathYAML": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "DEPRECATEDYAML": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "Region": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "Service": { "description": "Deprecated", "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/chief" }, "GlobalAddons": { "description": "GlobalAddons contains all available addon names for Chief", "type": "object", "properties": { "DEPRECATEDAddonNames": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minItems": 0, "maxItems": 100 }, "DEPRECATEDDummy": { "description": "TODO Remove this...", "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "Region": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "Service": { "description": "Deprecated", "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/chief" }, "HTTPHeader": { "description": "HTTPHeader used in AkamaiHealthcheckProperties struct", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "value": { "type": "string", "x-go-name": "Value", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "HasValidEntitlementResponse": { "description": "HasValidEntitlementResponse contains the information if the requested entitlement is supported or not", "type": "object", "properties": { "hasValidEntitlement": { "type": "boolean", "x-go-name": "HasValidEntitlement" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "Health": { "description": "Health is the health status of the host", "type": "object", "properties": { "message": { "description": "A message to describe the health status", "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "modifiedDate": { "description": "The timestamp of the last health status update", "type": "string", "x-go-name": "ModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "description": "The health status of the workload that runs on the host. Possible values include normal, provisioning, unknown, unresponsive, ready, and reload-required. For more information, see the docs 'http://ibm.biz/sat-host-health'", "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "HealthIssueListItem": { "type": "object", "title": "Structure used in a list API response.", "properties": { "component": { "type": "string", "x-go-name": "Component", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "detected": { "type": "string", "x-go-name": "Detected", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "severity": { "type": "string", "x-go-name": "Severity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "_HealthIssueListItem", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "HealthMonitorConfiguration": { "description": "HealthMonitorConfiguration is a common struct to be used in NLB health monitor related APIs", "type": "object", "properties": { "akamaiMonitorConfiguration": { "$ref": "#/components/schemas/AkamaiHealthcheckProperties" }, "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbSubdomain": { "type": "string", "x-go-name": "NlbSubdomain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "HealthMonitorProperties": { "type": "object", "title": "HealthMonitorProperties defines the properties we support configuring for health monitoring. This is a common configuration that is translated to DNS provider specific configurations.", "properties": { "host": { "description": "Value of the Host header and the TLS SNI. (not valid for tcp protocol)", "type": "string", "x-go-name": "Host", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "intervalSeconds": { "description": "Interval between checks in seconds.", "type": "integer", "format": "int64", "x-go-name": "IntervalSeconds", "minimum": 0, "maximum": 2147483647 }, "path": { "description": "Path of the request. (not valid for tcp protocol)", "type": "string", "x-go-name": "Path", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "port": { "description": "Destination port for the request.", "type": "integer", "format": "int64", "x-go-name": "Port", "minimum": 0, "maximum": 2147483647 }, "protocol": { "description": "The protocol to use for healthcheck: http, https or tcp.", "type": "string", "x-go-name": "Protocol", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "timeoutSeconds": { "description": "Timeout for the individual checks to complete in seconds.", "type": "integer", "format": "int64", "x-go-name": "TimeoutSeconds", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "HealthcheckProperties": { "description": "HealthcheckProperties used for storing config provided by user for healthcheck\ndeprecated", "type": "object", "properties": { "allow_insecure": { "type": "boolean", "x-go-name": "AllowInsecure" }, "expectedBody": { "type": "string", "x-go-name": "ExpectedBody", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "expectedCodes": { "type": "string", "x-go-name": "ExpectedCodes", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "follow_redirects": { "type": "boolean", "x-go-name": "FollowRedirects" }, "header": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "minItems": 0, "maxItems": 100 }, "x-go-name": "Header" }, "interval": { "type": "integer", "format": "int64", "x-go-name": "Interval", "minimum": 0, "maximum": 2147483647 }, "method": { "type": "string", "x-go-name": "Method", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "path": { "type": "string", "x-go-name": "Path", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "port": { "type": "integer", "format": "uint16", "x-go-name": "Port", "minimum": 0, "maximum": 2147483647 }, "retries": { "type": "integer", "format": "int64", "x-go-name": "Retries", "minimum": 0, "maximum": 2147483647 }, "timeout": { "type": "integer", "format": "int64", "x-go-name": "Timeout", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "Hosts": { "description": "Hosts lists the hosts belonging to the IBM Cloud Satellite location", "type": "object", "properties": { "available": { "description": "The available number of hosts that can be assigned to a cluster resource in the Satellite location", "type": "integer", "format": "int64", "x-go-name": "Available", "minimum": 0, "maximum": 2147483647 }, "total": { "description": "The total number of hosts that are attached to the Satellite location", "type": "integer", "format": "int64", "x-go-name": "Total", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "IAAS": { "type": "object", "title": "IAAS Optional: Details about the infrastructure provider that the IBM Cloud Satellite location uses.", "properties": { "credential": { "description": "A JSON encoded credential string specific to the chosen provider", "type": "array", "items": { "type": "integer", "format": "uint8", "minimum": 0, "maximum": 2147483647 }, "x-go-name": "Credential", "minItems": 0, "maxItems": 100 }, "provider": { "description": "The name of the infrastructure provider for the Satellite location, such as AWS, Azure, GCP or IBM Cloud.", "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "description": "The name of region in the infrastructure provider that is used for the Satellite location, such as the AWS 'us-east-2' region.", "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "IKSLocation": { "description": "IKSLocation properties", "type": "object", "properties": { "country": { "type": "string", "x-go-name": "Country", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "display_name": { "type": "string", "x-go-name": "DisplayName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "geography": { "type": "string", "x-go-name": "Geography", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kind": { "type": "string", "x-go-name": "Kind", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "metro": { "type": "string", "x-go-name": "Metro", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multizone_metro": { "type": "string", "x-go-name": "MultizoneMetro", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "satelliteEnabled": { "type": "boolean", "x-go-name": "SatelliteEnabled" }, "supportsFree": { "type": "boolean", "x-go-name": "SupportsFree" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v1/globalapi" }, "IKSVersion": { "description": "IKSVersion the IKS version", "type": "object", "properties": { "default": { "type": "boolean", "x-go-name": "Default" }, "end_of_service": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "major": { "type": "integer", "format": "int64", "x-go-name": "Major", "minimum": 0, "maximum": 2147483647 }, "minor": { "type": "integer", "format": "int64", "x-go-name": "Minor", "minimum": 0, "maximum": 2147483647 }, "patch": { "type": "integer", "format": "int64", "x-go-name": "Patch", "minimum": 0, "maximum": 2147483647 }, "preview_state": { "type": "string", "x-go-name": "PreviewState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "IgnoredIngressStatusErrors": { "description": "IgnoredIngressStatusErrors is used to ignore errors for ingress status", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ignoredErrors": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IgnoredErrors", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress-status" }, "ImageSecurity": { "description": "ImageSecurity defines a request to enable/disable image-security", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "Images": { "description": "Images stores the list of native IKS and external ingress controller images that are available to be used", "type": "object", "properties": { "albHealthCheckerVersion": { "type": "string", "x-go-name": "ALBHealthCheckerVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultIKSVersion": { "type": "string", "x-go-name": "DefaultIKSVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultK8sVersion": { "type": "string", "x-go-name": "DefaultK8sVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultTraefikVersion": { "type": "string", "x-go-name": "DefaultTraefikVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ingressAuthVersion": { "type": "string", "x-go-name": "IngressAuthVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "k8sStatus": { "type": "string", "x-go-name": "K8sStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pre116K8sImage": { "type": "string", "x-go-name": "Pre116K8SImage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pre119K8sImage": { "type": "string", "x-go-name": "Pre119K8SImage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedIKSVersions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedIKSVersions", "minItems": 0, "maxItems": 100 }, "supportedK8sVersions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedK8sVersions", "minItems": 0, "maxItems": 100 }, "supportedTraefikVersions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedTraefikVersions", "minItems": 0, "maxItems": 100 }, "traefikStatus": { "type": "string", "x-go-name": "TraefikStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "IngestionKeys": { "description": "IngestionKeys Optional: Keys that can be passed in during Satellite location creation", "type": "object", "properties": { "activity_tracker_key": { "type": "string", "x-go-name": "ActivityTrackerKey", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logging_key": { "type": "string", "x-go-name": "LoggingKey", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "Instance": { "description": "Instance struct holding details for a single instance", "type": "object", "properties": { "callbackChannel": { "type": "string", "x-go-name": "CallbackChannel", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretGroupID": { "type": "string", "x-go-name": "SecretGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretGroupName": { "type": "string", "x-go-name": "SecretGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "userManaged": { "type": "boolean", "x-go-name": "UserManaged" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/instance" }, "InstanceGroup": { "description": "InstanceGroup common worker pool data", "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "machineType": { "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "maxSizePerZone": { "type": "integer", "format": "int64", "x-go-name": "MaxSize", "minimum": 0, "maximum": 2147483647 }, "minSizePerZone": { "type": "integer", "format": "int64", "x-go-name": "MinSize", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "sizePerZone": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "InstanceGroupPatchRequest": { "description": "InstanceGroupPatchRequest provides attributes to patch update instance group", "type": "object", "properties": { "desiredSize": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 }, "reasonForResize": { "type": "string", "x-go-name": "ReasonForResize", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "InstanceGroupResponse": { "description": "InstanceGroupResponse provides instance group data", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "machineType": { "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "maxSizePerZone": { "type": "integer", "format": "int64", "x-go-name": "MaxSize", "minimum": 0, "maximum": 2147483647 }, "minSizePerZone": { "type": "integer", "format": "int64", "x-go-name": "MinSize", "minimum": 0, "maximum": 2147483647 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reasonForDelete": { "type": "string", "x-go-name": "ReasonForDelete", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "sizePerZone": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPoolID": { "type": "string", "x-go-name": "WorkerPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "InstanceGroupResponses": { "type": "array", "title": "InstanceGroupResponses sorts InstanceGroupResponse by ID.", "items": { "$ref": "#/components/schemas/InstanceGroupResponse" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1", "minItems": 0, "maxItems": 100 }, "InstanceStorage": { "description": "InstanceStorage type for describing an instance disk configuration", "type": "object", "properties": { "count": { "type": "integer", "format": "int64", "x-go-name": "Count", "minimum": 0, "maximum": 2147483647 }, "size": { "description": "the size of each individual device in GB", "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "InstanceUpdateConfig": { "description": "UpdateConfig instance update request", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretGroupID": { "type": "string", "x-go-name": "SecretGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "UpdateConfig", "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/instance" }, "Instances": { "description": "Instances struct for a secret array", "type": "array", "items": { "$ref": "#/components/schemas/Instance" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/instance", "minItems": 0, "maxItems": 100 }, "KeyProtectData": { "description": "KeyProtectData represents a single version of a CRK which is created by armada-api\nafter a customer request, passed by armada-deploy to armada-ansible", "type": "object", "required": [ "url", "instanceID", "crkID" ], "properties": { "accountID": { "description": "AccountID stores the ID of the account where the key protect instance resides\nIts value can be either:\nthe same account ID the given cluster resides in (non cross account use case)\nnot the clusters account ID in which the KMS instance resides (cross account use case)\nempty, in case of old clusters which were secret encrypted before this AccountID field was added to this struct.\nThis case falls back to the first point and should be handled like that (non cross account use case)", "type": "string", "x-go-name": "AccountID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "correlationID": { "description": "The correlation ID stores the correlation ID used to trace a CRK call through\nmultiple services", "type": "string", "x-go-name": "CorrelationID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crkID": { "description": "CRK is a Key Protect customer root key. To get the CRK, see http://ibm.biz/kp-viewcrk", "type": "string", "x-go-name": "CRK", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "instanceID": { "description": "InstanceID is a Key Protect instance ID. To get the instance ID, run 'ibmcloud resource service-instance --id' and copy the second value (not the full CRN)", "type": "string", "x-go-name": "InstanceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceToService": { "description": "ServiceToService indicates the KP information in this record was enabled via service-to-service\nintegration, so an associated registration was created.", "type": "boolean", "x-go-name": "ServiceToService" }, "url": { "description": "URL is a Key Protect endpoint. To get the endpoint, see http://ibm.biz/kp-endpoints", "type": "string", "x-go-name": "URL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model" }, "KubeVersion": { "description": "KubeVersion the kubernetes version", "type": "object", "properties": { "default": { "type": "boolean", "x-go-name": "Default" }, "end_of_service": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "major": { "type": "integer", "format": "int64", "x-go-name": "Major", "minimum": 0, "maximum": 2147483647 }, "minor": { "type": "integer", "format": "int64", "x-go-name": "Minor", "minimum": 0, "maximum": 2147483647 }, "patch": { "type": "integer", "format": "int64", "x-go-name": "Patch", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "Kubeconfig": { "type": "object", "title": "Kubeconfig contains the fields necessary to request a kubeconfig file.", "properties": { "admin": { "description": "AdminUser Retrieve the admin kubeconfig file.", "type": "boolean", "x-go-name": "AdminUser" }, "cluster": { "description": "The name or ID of the cluster that you want to get the worker node details from. To list the clusters that you have access to, use the `GET /v2/getClusters` API or run `ibmcloud ks cluster ls`.", "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "endpointType": { "description": "EndpointType Default endpoint is the public endpoint if available, private otherwise. Use 'private' to require a private endpoint and 'link' for a Satellite Link endpoint.", "type": "string", "x-go-name": "EndpointType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "format": { "description": "Format Default format is json. Other options include yaml, and zip.", "type": "string", "x-go-name": "Format", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "network": { "description": "NetworkConfig Retrieve the Calico network config. Requires admin=true and format=zip.", "type": "boolean", "x-go-name": "NetworkConfig" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "KubeconfigOptions": { "type": "object", "title": "KubeconfigOptions contains the fields necessary to generate a kubeconfig file.", "properties": { "admin": { "description": "AdminUser Retrieve the admin kubeconfig file.", "type": "boolean", "x-go-name": "AdminUser" }, "endpointType": { "description": "EndpointType Default endpoint is the public endpoint if available, private otherwise. Use 'private' to require a private endpoint and 'link' for a Satellite Link endpoint.", "type": "string", "x-go-name": "EndpointType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "format": { "description": "Format Default format is json. Other options include yaml, and zip.", "type": "string", "x-go-name": "Format", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "network": { "description": "NetworkConfig Retrieve the Calico network config. Requires admin=true and format=zip.", "type": "boolean", "x-go-name": "NetworkConfig" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "LBBackendConfig": { "description": "LBBackendConfig stuct for configuring the loadbalancer's backend", "type": "object", "properties": { "private": { "type": "string", "x-go-name": "Private", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "public": { "type": "string", "x-go-name": "Public", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "LBConfig": { "description": "LBConfig struct models load balancer configuration", "type": "object", "properties": { "backend": { "$ref": "#/components/schemas/LBBackendConfig" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "proxyProtocol": { "$ref": "#/components/schemas/LBProxyProtocolConfig" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "LBProxyProtocolConfig": { "description": "LBProxyProtocolConfig stuct for storing the loadbalancer's proxy protocol config in etcd", "type": "object", "properties": { "cidr": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "CIDR", "minItems": 0, "maxItems": 100 }, "enable": { "type": "boolean", "x-go-name": "Enable" }, "headerTimeout": { "type": "integer", "format": "int64", "x-go-name": "HeaderTimeout", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "Label": { "description": "Label a host label key value pair", "type": "object", "properties": { "key": { "type": "string", "x-go-name": "Key", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "value": { "type": "string", "x-go-name": "Value", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "ListStorageConfigData": { "description": "ListStorageConfigData is the response struct for the list storage configuration APIs\ni.e. getStorageConfigurations & getStorageConfigurationsByController", "type": "object", "properties": { "config-name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "config-version": { "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "created": { "type": "string", "x-go-name": "Created", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "is-revision-update-available": { "type": "boolean", "x-go-name": "IsRevisionUpdateAvailable" }, "latest-revision": { "type": "string", "x-go-name": "LatestRevision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "revision": { "type": "string", "x-go-name": "Revision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-template-metadata": { "$ref": "#/components/schemas/ConfigAttributes" }, "storage-template-name": { "type": "string", "x-go-name": "StorageTemplateName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-template-version": { "type": "string", "x-go-name": "StorageTemplateVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "template-status": { "type": "string", "x-go-name": "TemplateStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "LocalObjectReference": { "description": "New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.\n1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular\nrestrictions like, \"must refer only to types A and B\" or \"UID not honored\" or \"name must be restricted\".\nThose cannot be well described when embedded.\n2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.\n3. We cannot easily change it. Because this type is embedded in many locations, updates to this type\nwill affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control.\n\nInstead of using this type, create a locally provided and used type that is well-focused on your reference.\nFor example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .\n+structType=atomic", "type": "object", "title": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "k8s.io/api/core/v1" }, "LogConfig": { "type": "object", "title": "LogConfig stores a logging configuration.", "properties": { "appLogContainers": { "description": "A list of container names that you want to collect logs for.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AppLogContainers", "minItems": 0, "maxItems": 100 }, "appLogPaths": { "description": "A list of app paths that you want to collect logs for.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AppLogPaths", "minItems": 0, "maxItems": 100 }, "caCert": { "description": "The name of the Kubernetes secret that holds the Certificate Authority certificate that you want to use for the syslog TLS termination.", "type": "string", "x-go-name": "CACert", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "errors": { "description": "A list of errors that occurred during the last logging config update.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Errors", "minItems": 0, "maxItems": 100 }, "id": { "description": "The unique identifier of the log source.", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSource": { "description": "The type of logs that you want to read and forward to the logging server. Supported values are `container`, `kubernetes`, `ingress`, `worker`, and `application`.", "type": "string", "x-go-name": "LogSource", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "loggingType": { "description": "The logging protocol to use. Supported values are `syslog` and `ibm`.", "type": "string", "x-go-name": "LoggingType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "description": "The Kubernetes namespace where the logging type is applied. This parameter is set only when the `container` log source is used.", "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "org": { "description": "The name of the Cloud Foundry organization where the logging configuration was created.", "type": "string", "x-go-name": "OrgName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "orgGUID": { "description": "The GUID of the Cloud Foundry organization where the logging configuration was created.", "type": "string", "x-go-name": "OrgGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "protocol": { "description": "The protocol that you want to use for syslog forwarding. Supported values are `TCP` and `UDP`. If no value is provided, the protocol is set to `UDP` by default.", "type": "string", "x-go-name": "SyslogProtocol", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "remoteLogPort": { "description": "The port of the logging server.", "type": "integer", "format": "int64", "x-go-name": "Port", "minimum": 0, "maximum": 2147483647 }, "remoteLogServer": { "description": "The hostname or IP address of the logging server.", "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "space": { "description": "The name of the Cloud Foundry space where the logging configuration was created.", "type": "string", "x-go-name": "SpaceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "spaceGUID": { "description": "The GUID of the Cloud Foundry space where the logging configuration was created.", "type": "string", "x-go-name": "SpaceGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "verifyMode": { "description": "The verification mode that is used for the syslog TLS protocol.", "type": "string", "x-go-name": "VerifyMode", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "description": "Internal use only.", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "LogConfigBody": { "description": "LogConfigBody is how users will interact with the logging endpoints", "type": "object", "properties": { "appLogContainers": { "description": "A list of container names that you want to collect logs for.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AppLogContainers", "minItems": 0, "maxItems": 100 }, "appLogPaths": { "description": "A list of app paths that you want to collect logs for.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AppLogPaths", "minItems": 0, "maxItems": 100 }, "caCert": { "description": "The name of the Kubernetes secret that holds the Certificate Authority certificate that you want to use for the syslog TLS termination.", "type": "string", "x-go-name": "CACert", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "loggingType": { "description": "The logging type that you want to use. Supported values are `syslog` and `ibm`.", "type": "string", "x-go-name": "LoggingType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "description": "The Kubernetes namespace where the logging configuration is applied.", "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "org": { "description": "The name of the Cloud Foundry organization where the logging configuration is created.", "type": "string", "x-go-name": "Org", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "protocol": { "description": "The protocol that you want to use for syslog forwarding. Supported values are TCP, TLS and UDP. If no value is provided, the protocol is set to UDP by default.", "type": "string", "x-go-name": "SyslogProtocol", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "remoteLogPort": { "description": "The port that the logging server uses. This value is required only when `LoggingType` is set to `syslog`.", "type": "integer", "format": "int64", "x-go-name": "Port", "minimum": 0, "maximum": 2147483647 }, "remoteLogServer": { "description": "The hostname or IP address of the logging server. This values is required only if `LoggingType` is set to `syslog`.", "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "space": { "description": "The name of the Cloud Foundry space where the logging configuration is created.", "type": "string", "x-go-name": "Space", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "verifyMode": { "description": "The verification mode that you want to use for the syslog TLS protocol. By default, `verify-none` is used. Other supported values include `verify-peer`, `verify-client-once`, and `verify-if-no-peer-cert`.", "type": "string", "x-go-name": "VerifyMode", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "LogConfigResponse": { "description": "LogConfigResponse is how users will see their logging configs from API responses", "type": "object", "properties": { "appLogContainers": { "description": "A list of container names that you want to collect logs for.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AppLogContainers", "minItems": 0, "maxItems": 100 }, "appLogPaths": { "description": "A list of app paths that you want to collect logs for.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AppLogPaths", "minItems": 0, "maxItems": 100 }, "caCert": { "description": "The name of the Kubernetes secret that holds the Certificate Authority certificate that you want to use for the syslog TLS termination.", "type": "string", "x-go-name": "CACert", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "endpoint": { "description": "The IBM Cloud Log Analysis with LogDNA API endpoint that the logging configuration uses.", "type": "string", "x-go-name": "Endpoint", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "errors": { "description": "A list of errors that occurred during the last logging config update.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Errors", "minItems": 0, "maxItems": 100 }, "id": { "description": "The unique identifier of the log source.", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSource": { "description": "The type of logs that you want to read and forward to the logging server. Supported values are `container`, `kubernetes`, `ingress`, `worker`, and `application`.", "type": "string", "x-go-name": "LogSource", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logSourceContainers": { "description": "A list of container names that logs are collected for and forwarded to the logging server.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Containers", "minItems": 0, "maxItems": 100 }, "logSourcePaths": { "description": "A list of app paths that logs are collected for and forwarded to the logging server.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Paths", "minItems": 0, "maxItems": 100 }, "loggingType": { "description": "The logging protocol to use. Supported values are `syslog` and `ibm`.", "type": "string", "x-go-name": "LoggingType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "description": "The Kubernetes namespace where the logging type is applied. This parameter is set only when the `container` log source is used.", "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "org": { "description": "The name of the Cloud Foundry organization where the logging configuration was created.", "type": "string", "x-go-name": "OrgName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "orgGUID": { "description": "The GUID of the Cloud Foundry organization where the logging configuration was created.", "type": "string", "x-go-name": "OrgGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "protocol": { "description": "The protocol that you want to use for syslog forwarding. Supported values are `TCP` and `UDP`. If no value is provided, the protocol is set to `UDP` by default.", "type": "string", "x-go-name": "SyslogProtocol", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "remoteLogPort": { "description": "The port of the logging server.", "type": "integer", "format": "int64", "x-go-name": "Port", "minimum": 0, "maximum": 2147483647 }, "remoteLogServer": { "description": "The hostname or IP address of the logging server.", "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "space": { "description": "The name of the Cloud Foundry space where the logging configuration was created.", "type": "string", "x-go-name": "SpaceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "spaceGUID": { "description": "The GUID of the Cloud Foundry space where the logging configuration was created.", "type": "string", "x-go-name": "SpaceGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "verifyMode": { "description": "The verification mode that is used for the syslog TLS protocol.", "type": "string", "x-go-name": "VerifyMode", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "description": "Internal use only.", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "MSCRegisterResp": { "description": "MSCRegisterResp is returned once multishift controller domains have been registered", "type": "object", "properties": { "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dnsRegistrations": { "type": "array", "items": { "$ref": "#/components/schemas/Registration" }, "x-go-name": "DNSRegistrations", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "MSCRegistration": { "description": "MSCRegistration is used to initiate registration of multishift controllers", "type": "object", "properties": { "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ips": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IPs", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "MachineType": { "description": "MachineType properties", "type": "object", "properties": { "cores": { "type": "string", "x-go-name": "Cores", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "correspondingMachineType": { "type": "string", "x-go-name": "CorrespondingMachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "gpus": { "type": "string", "x-go-name": "GPUs", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isTrusted": { "type": "boolean", "x-go-name": "IsTrusted" }, "memory": { "type": "string", "x-go-name": "Memory", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkSpeed": { "type": "string", "x-go-name": "NetworkSpeed", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ocp_unsupported": { "type": "boolean", "x-go-name": "OCPUnsupported" }, "os": { "type": "string", "x-go-name": "OS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorage": { "type": "string", "x-go-name": "SecondaryStorage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageEncrypted": { "type": "boolean", "x-go-name": "SecondaryStorageEncrypted" }, "serverType": { "type": "string", "x-go-name": "ServerType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage": { "type": "string", "x-go-name": "Storage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "MachineTypes": { "description": "MachineTypes a type that returns a sorted array of machine types", "type": "array", "items": { "$ref": "#/components/schemas/MachineType" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1", "minItems": 0, "maxItems": 100 }, "MasterAPIServer": { "description": "MasterAPIServer describes the state to put the Master API server into", "type": "object", "properties": { "action": { "description": "The action to perform on the API Server.", "type": "string", "x-go-name": "Action", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "MasterLogCollectionRequest": { "description": "MasterLogCollectionRequest contains the information necessary to initiate master log collection", "type": "object", "properties": { "accesskeyid": { "description": "The ID of the HMAC key that you want to use to authenticate with IBM Cloud Object Storage when master logs are uploaded.", "type": "string", "x-go-name": "AccessKeyID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "accesskeysecret": { "description": "The secret of the HMAC credentials that you want to use to authenticate with IBM Cloud Object Storage when master logs are uploaded.", "type": "string", "x-go-name": "AccessKeySecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "bucket": { "description": "The IBM Cloud Object Storage bucket that you want to use to upload master logs.", "type": "string", "x-go-name": "Bucket", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "endpoint": { "description": "The IBM Cloud Object Storage API endpoint that you want to use to send master logs to.", "type": "string", "x-go-name": "S3Endpoint", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "MasterLogCollectionStatusResponseBody": { "description": "MasterLogCollectionStatusResponseBody is the response body format for log collection statuses", "type": "object", "properties": { "error": { "description": "A list of errors that occurred when the log collection request was processed.", "type": "string", "x-go-name": "Error", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "startTime": { "description": "The timestamp when the log collection request was initiated.", "type": "string", "x-go-name": "StartTime", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The state of the master log collection request.", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "urls": { "description": "A list of s3 URLs that are used for IBM Cloud Object Storage artifacts that are created by the log collection request.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "URLs", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "MessageLevel": { "type": "string", "title": "MessageLevel is used to indicate the severity level of a message.", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "MessageResponse": { "description": "MessageResponse is a user message returned from the API", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "services": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Services", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "MigratedResource": { "description": "MigratedResource represents a single resource that has been migrated", "type": "object", "properties": { "kind": { "type": "string", "x-go-name": "Kind", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "migratedAs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "MigratedAs", "minItems": 0, "maxItems": 100 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "warnings": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Warnings", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "MigrationStatus": { "description": "MigrationStatus status of the migration job on cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "migratedResources": { "type": "array", "items": { "$ref": "#/components/schemas/MigratedResource" }, "x-go-name": "MigratedResources", "minItems": 0, "maxItems": 100 }, "migrationMode": { "type": "string", "x-go-name": "MigrationMode", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subdomainMap": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SubdomainMap" }, "testSecret": { "type": "string", "x-go-name": "TestSecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "testSubdomain": { "type": "string", "x-go-name": "TestSubdomain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "MultishiftClusterHosts": { "description": "MultishiftClusterHosts describes the hosts assigned to a cluster", "type": "object", "properties": { "assigned": { "type": "integer", "format": "int64", "x-go-name": "Assigned", "minimum": 0, "maximum": 2147483647 }, "unsatisfiedLabels": { "type": "array", "items": { "$ref": "#/components/schemas/UnsatisfiedLabels" }, "x-go-name": "UnsatisfiedLabels", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "MultishiftController": { "description": "MultishiftController describes an individual controller", "type": "object", "properties": { "activityTrackerKeyProvided": { "description": "ActivityTrackerKeyProvided indicates whether an Activity Tracker key was provided for the Satellite location", "type": "boolean", "x-go-name": "ActivityTrackerKeyProvided" }, "capabilitiesManagedBySatellite": { "description": "Satellite capabilities attached to the location.", "type": "array", "items": { "$ref": "#/components/schemas/CapabilityManagedBySatellite" }, "x-go-name": "SatelliteCapabilities", "minItems": 0, "maxItems": 100 }, "coreosEnabled": { "description": "CoreOSEnabled indicates whether the cluster type supports CoreOS", "type": "boolean", "x-go-name": "CoreOSEnabled" }, "createdDate": { "description": "The timestamp when the Satellite location was created", "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "description": "The CRN for the Satellite location", "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "deployments": { "$ref": "#/components/schemas/Deployments" }, "hostUpdateSeverity": { "description": "HostUpdateSeverity indicates the highest update severity among all worker nodes (hosts) in this location.\nPossible values: \"\" (no update needed), warning (behind by patch/build version), critical (behind by major/minor version).", "type": "string", "x-go-name": "HostUpdateSeverity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hosts": { "$ref": "#/components/schemas/Hosts" }, "iaas": { "$ref": "#/components/schemas/IAAS" }, "id": { "description": "The Satellite location ID", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "location": { "description": "The IBM Cloud metro that the Satellite location is managed from", "type": "string", "x-go-name": "ManagedFrom", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "logDNAKeyProvided": { "description": "LogDNAKeyProvided indicates whether a LogDNA key was provided for the Satellite location", "type": "boolean", "x-go-name": "LogDNAKeyProvided" }, "name": { "description": "The Satellite location name", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "description": "The IBM Cloud region that the Satellite location is managed from", "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "description": "ResourceGroupID the ID of the resource group that owns the Satellite location", "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "description": "ResourceGroupName the name of the resource group that owns the Satellite location", "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The health state of the Satellite location. Possible values include action required, critical, host required, normal, and provisioning. For more information, see the docs 'http://ibm.biz/sat-loc-health'", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "MultishiftCreateAssignment": { "description": "MultishiftCreateAssignment struct required to create an assignment", "type": "object", "properties": { "cluster": { "description": "The name or ID of a Satellite location or cluster to assign the host to", "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "ControllerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostID": { "description": "Optional: The name or ID of the specific host to assign to a Satellite location or cluster", "type": "string", "x-go-name": "HostID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "workerpool": { "description": "Optional: The name or ID of the worker pool within the cluster to assign the host to", "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "description": "Optional: The zone within the cluster to assign the host to", "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftCreateAssignmentResponse": { "description": "MultishiftCreateAssignment create multishift assignment response", "type": "object", "properties": { "hostID": { "type": "string", "x-go-name": "HostID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "MultishiftCreateAssignment", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "MultishiftCreateCluster": { "type": "object", "title": "MultishiftCreateCluster contains fields necessary for a customer to request a multishift cluster.", "properties": { "adminAgentOptIn": { "description": "Optional: User provided value to indicate opt-in agreement to SatCon admin agent", "type": "boolean", "x-go-name": "AdminAgentOptIn" }, "calicoIPAutodetection": { "description": "Optional: Used to determine the correct IP for internal routing", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "CalicoIPAutodetection" }, "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "defaultWorkerPoolEntitlement": { "description": "Optional: The entitlement to use in the default worker pool", "type": "string", "x-go-name": "DefaultWorkerPoolEntitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "infrastructureTopology": { "description": "Optional: Enables single worker node clusters", "type": "string", "x-go-name": "InfrastructureTopology", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "description": "Optional: The OpenShift Container Platform version", "type": "string", "x-go-name": "KubeVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "description": "The unique name for the new IBM Cloud Satellite cluster", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "description": "Optional: NetworkPlugin indicates what container network interface has to be used in the cluster. If the field is missing it is defaulted to Calico.", "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "description": "Optional: The operating system to use in the default worker pool", "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "description": "Optional: User provided value for the pod subnet", "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pullSecret": { "description": "Optional: The RedHat pull secret to create the OpenShift cluster", "type": "string", "x-go-name": "PullSecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "requestSecure": { "description": "Optional: Flag to request a secure cluster is created", "type": "boolean", "x-go-name": "RequestSecure" }, "serviceSubnet": { "description": "Optional: User provided value for service subnet", "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "description": "Optional: The trusted profile ID to set in the cluster", "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "description": "Optional: The number of worker nodes to create per zone in the default worker pool", "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "zone": { "description": "Optional: The name of the zone to create the default worker pool in", "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftCreateClusterFragment": { "type": "object", "title": "MultishiftCreateClusterFragment contains the fields specific to multishift create cluster requests.", "properties": { "calicoIPAutodetection": { "description": "Optional: Used to determine the correct IP for internal routing", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "CalicoIPAutodetection" }, "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "infrastructureTopology": { "description": "Optional: Enables single worker node clusters", "type": "string", "x-go-name": "InfrastructureTopology", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "description": "Optional: NetworkPlugin indicates what container network interface has to be used in the cluster. If the field is missing it is defaulted to Calico.", "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pullSecret": { "description": "Optional: The RedHat pull secret to create the OpenShift cluster", "type": "string", "x-go-name": "PullSecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftCreateClusterInternal": { "type": "object", "title": "MultishiftCreateClusterInternal internal representation of a multishift cluster create request.", "properties": { "calicoIPAutodetection": { "description": "Optional: Used to determine the correct IP for internal routing", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "CalicoIPAutodetection" }, "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cosInstanceCRN": { "type": "string", "x-go-name": "COSInstanceCRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cseACLEnabled": { "type": "boolean", "x-go-name": "CSEACLEnabled" }, "defaultWorkerPoolEntitlement": { "type": "string", "x-go-name": "DefaultWorkerPoolEntitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableOutboundTrafficProtection": { "type": "boolean", "x-go-name": "DisableOutboundTrafficProtection" }, "disablePublicServiceEndpoint": { "type": "boolean", "x-go-name": "DisablePublicServiceEndpoint" }, "infrastructureTopology": { "description": "Optional: Enables single worker node clusters", "type": "string", "x-go-name": "InfrastructureTopology", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "type": "string", "x-go-name": "KubeVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "description": "Optional: NetworkPlugin indicates what container network interface has to be used in the cluster. If the field is missing it is defaulted to Calico.", "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "previews": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Previews", "minItems": 0, "maxItems": 100 }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pullSecret": { "description": "Optional: The RedHat pull secret to create the OpenShift cluster", "type": "string", "x-go-name": "PullSecret", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "requestSecure": { "type": "boolean", "x-go-name": "RequestSecure" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPool": { "$ref": "#/components/schemas/VPCCreateClusterWorkerPool" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftCreateClusterResponse": { "description": "MultishiftCreateCluster create multishift cluster response", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "MultishiftCreateCluster", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "MultishiftCreateController": { "description": "MultishiftCreateController struct required to create a controller", "type": "object", "properties": { "calicoIPAutodetection": { "description": "Optional: Used to determine the correct IP for internal routing", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "CalicoIPAutodetection" }, "capabilitiesManagedBySatellite": { "description": "Satellite capabilities attached to the location", "type": "array", "items": { "$ref": "#/components/schemas/CapabilityManagedBySatellite" }, "x-go-name": "CapabilitiesManagedBySatellite", "minItems": 0, "maxItems": 100 }, "coreos_enabled": { "description": "Indicates whether CoreOS features should be enabled for the location", "type": "boolean", "x-go-name": "CoreOSEnabled" }, "cos_config": { "$ref": "#/components/schemas/COSBucket" }, "cos_credentials": { "$ref": "#/components/schemas/COSAuthorization" }, "description": { "description": "A description of the new Satellite location", "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iaas": { "$ref": "#/components/schemas/IAAS" }, "ingestion_keys": { "$ref": "#/components/schemas/IngestionKeys" }, "location": { "description": "The IBM Cloud metro from which the Satellite location is managed", "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "loggingAccountID": { "description": "The account ID for IBM Log Analysis with LogDNA log forwarding", "type": "string", "x-go-name": "LoggingAccountID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multishiftPodSubnet": { "description": "Optional: Used to determine the pod subnet", "type": "string", "x-go-name": "MultishiftPodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multishiftServiceSubnet": { "description": "Optional: Used to determine the service subnet", "type": "string", "x-go-name": "MultishiftServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "description": "A unique name for the new Satellite location", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "physicalAddress": { "description": "An optional physical address of the new Satellite location which is deployed on premise", "type": "string", "x-go-name": "PhysicalAddress", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zones": { "description": "The names of at least three high availability zones to use for the location (e.g. cloud-zone-1, cloud-zone-2, cloud-zone-3)", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftCreateControllerResponse": { "description": "MultishiftCreateController create controller response", "type": "object", "properties": { "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "MultishiftCreateController", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "MultishiftCreateNode": { "description": "MultishiftCreateNode struct required to register a node", "type": "object", "properties": { "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "ControllerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostIP": { "type": "string", "x-go-name": "IPAddress", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "identifier": { "type": "string", "x-go-name": "Identifier", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnet": { "type": "string", "x-go-name": "Subnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftCreateNodeFragment": { "description": "MultishiftCreateNodeFragment contains properties specific to creating a new queue node", "type": "object", "properties": { "hostIP": { "type": "string", "x-go-name": "IPAddress", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "identifier": { "type": "string", "x-go-name": "Identifier", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnet": { "type": "string", "x-go-name": "Subnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftCreateScript": { "description": "MultishiftCreateScript struct required to request a host attachment script", "type": "object", "properties": { "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "ControllerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLinkAgentEndpoint": { "type": "string", "x-go-name": "HostLinkAgentEndpoint", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resetHostKey": { "type": "boolean", "x-go-name": "ResetHostKey" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftGetController": { "description": "MultishiftGetController describes a multishift controller", "type": "object", "properties": { "activityTrackerKeyProvided": { "type": "boolean", "x-go-name": "ActivityTrackerKeyProvided" }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/CommonClusterAddon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "caCertRotationStatus": { "$ref": "#/components/schemas/CommonClusterCACertRotation" }, "calicoIPAutodetectionConfig": { "type": "string", "x-go-name": "CalicoIPAutodetectionConfig", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "capabilitiesManagedBySatellite": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityManagedBySatellite" }, "x-go-name": "SatelliteCapabilities", "minItems": 0, "maxItems": 100 }, "coreosEnabled": { "type": "boolean", "x-go-name": "CoreOSEnabled" }, "cos_config": { "$ref": "#/components/schemas/COSBucket" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "datacenter": { "type": "string", "x-go-name": "Datacenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "deployments": { "$ref": "#/components/schemas/Deployments" }, "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredTrustedProfileID": { "type": "string", "x-go-name": "DesiredTrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "etcdPort": { "type": "string", "x-go-name": "EtcdPort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "features": { "$ref": "#/components/schemas/CommonClusterFeatures" }, "hostUpdateSeverity": { "description": "HostUpdateSeverity indicates the highest update severity among all worker nodes (hosts) in this location.\nPossible values: \"\" (no update needed), warning (behind by patch/build version), critical (behind by minor version).", "type": "string", "x-go-name": "HostUpdateSeverity", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hosts": { "$ref": "#/components/schemas/Hosts" }, "iaas": { "$ref": "#/components/schemas/IAAS" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ignitionServerURL": { "type": "string", "x-go-name": "IgnitionServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ignition_server_port": { "type": "integer", "format": "int64", "x-go-name": "IgnitionServerPort", "minimum": 0, "maximum": 2147483647 }, "imageSecurityEnabled": { "type": "boolean", "x-go-name": "ImageSecurityEnabled" }, "ingress": { "$ref": "#/components/schemas/CommonClusterIngress" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "keyManagementService": { "$ref": "#/components/schemas/CommonClusterKMS" }, "konnectivityServerURL": { "type": "string", "x-go-name": "KonnectivityServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "konnectivity_server_port": { "type": "integer", "format": "int64", "x-go-name": "KonnectivityServerPort", "minimum": 0, "maximum": 2147483647 }, "lifecycle": { "$ref": "#/components/schemas/CommonClusterLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "locationZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "LocationZones", "minItems": 0, "maxItems": 100 }, "logDNAKeyProvided": { "type": "boolean", "x-go-name": "LogDNAKeyProvided" }, "masterKubeVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterURL": { "type": "string", "x-go-name": "MasterURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multiAzCapable": { "type": "boolean", "x-go-name": "MultiAZCapable" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "oauthServerURL": { "type": "string", "x-go-name": "OauthServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "open_vpn_server_port": { "type": "integer", "format": "int64", "x-go-name": "OpenVPNServerPort", "minimum": 0, "maximum": 2147483647 }, "outboundTrafficProtection": { "type": "string", "x-go-name": "OutboundTrafficProtection", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "physicalAddress": { "type": "string", "x-go-name": "PhysicalAddress", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "ProviderID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secureByDefault": { "type": "string", "x-go-name": "SecureByDefault", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secureRequested": { "type": "boolean", "x-go-name": "SecureRequested" }, "serviceEndpoints": { "$ref": "#/components/schemas/CommonClusterServiceEndpoint" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The lifecycle state of the cluster. Possible values include aborted, critical, delete_failed, deleted, deleting, deploy_failed, deploying, normal, pending, requested, updating, unsupported, and warning. For more information, see the docs 'http://ibm.biz/cluster-health-states'", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedOperatingSystems": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedOperatingSystems", "minItems": 0, "maxItems": 100 }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "virtualPrivateEndpointURL": { "type": "string", "x-go-name": "VirtualPrivateEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "VPCs", "minItems": 0, "maxItems": 100 }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "WorkerZones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "MultishiftNodeLabelFragment": { "description": "MultishiftNodeLabelFragment contains key-value pairs to describe a host", "type": "object", "properties": { "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftNodeLabelOptionalFragment": { "description": "MultishiftNodeLabelOptionalFragment contains optional key-value pairs to describe a host", "type": "object", "properties": { "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftNodeQueue": { "description": "MultishiftNodeQueue required to specify a node queue", "type": "object", "properties": { "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "ControllerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftQueueNode": { "description": "MultishiftQueueNode describes an individual queue node", "type": "object", "properties": { "assignment": { "$ref": "#/components/schemas/Assignment" }, "health": { "$ref": "#/components/schemas/Health" }, "id": { "description": "The unique ID of the host", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "description": "The unique name of the host", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The availability state of the host. Possible values include assigned and unassigned. For more information, see the docs 'http://ibm.biz/sat-host-health'", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "MultishiftRemoveNode": { "description": "MultishiftRemoveNode struct required to remove a node", "type": "object", "properties": { "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostID": { "description": "The name or ID of the host to remove", "type": "string", "x-go-name": "NodeID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "MultishiftUpdateNode": { "description": "MultishiftUpdateNode struct required to update a node", "type": "object", "properties": { "controller": { "description": "The name or ID of the Satellite location", "type": "string", "x-go-name": "ControllerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostID": { "description": "The name or ID of the host to update", "type": "string", "x-go-name": "NodeID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "description": "Key-value pairs to label the host, such as cpu=4 to describe the host capabilities", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "NetworkHealthMoreDetails": { "type": "object", "title": "Extra context for a health issue. Not all fields are populated for every issue type.", "properties": { "affected_component_type": { "description": "Kind of affected resource (for example secret, alb).", "type": "string", "x-go-name": "AffectedComponentType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "affected_components": { "description": "Names of affected resources.", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "AffectedComponents", "minItems": 0, "maxItems": 100 }, "message": { "description": "Optional human-readable message.", "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "description": "Detail schema version (for example 1 = NetworkHealthMoreDetailType001).", "type": "integer", "format": "int64", "x-go-name": "Type", "minimum": 0, "maximum": 2147483647 } }, "x-go-name": "_NetworkHealthMoreDetails", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "NlbConfig": { "description": "NlbConfig config for NLB configuration", "type": "object", "properties": { "certProvider": { "type": "string", "x-go-name": "CertProvider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "nlbDnsType": { "type": "string", "x-go-name": "NlbDNSType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbHost": { "type": "string", "x-go-name": "NlbHost", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbIPArray": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "NlbIPArray", "minItems": 0, "maxItems": 100 }, "nlbMonitorState": { "type": "string", "x-go-name": "NlbMonitorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbSslSecretName": { "type": "string", "x-go-name": "NlbSSLSecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbSslSecretStatus": { "type": "string", "x-go-name": "NlbSslSecretStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbStatusMessage": { "type": "string", "x-go-name": "NlbStatusMessage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbType": { "type": "string", "x-go-name": "NlbType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretNamespace": { "type": "string", "x-go-name": "SecretNamespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zoneID": { "type": "string", "x-go-name": "ZoneID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "NlbHealthCheckConfig": { "description": "NlbHealthCheckConfig config for Health check monitor configuration list", "type": "object", "properties": { "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "healthCheckStatus": { "type": "string", "x-go-name": "HealthCheckStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbHost": { "type": "string", "x-go-name": "NlbHost", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "path": { "type": "string", "x-go-name": "Path", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "port": { "type": "integer", "format": "uint16", "x-go-name": "Port", "minimum": 0, "maximum": 2147483647 }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "NlbHealthCheckStatus": { "description": "NlbHealthCheckStatus status of Health check monitors", "type": "object", "properties": { "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "monitorState": { "type": "string", "x-go-name": "MonitorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "monitorStatus": { "type": "string", "x-go-name": "MonitorStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbHost": { "type": "string", "x-go-name": "NlbHost", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbIP": { "type": "string", "x-go-name": "NlbIP", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "NlbHealthConfig": { "description": "NlbHealthConfig config for NLB Health configuration", "type": "object", "properties": { "allowInsecureSet": { "type": "string", "x-go-name": "AllowInsecureSet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdOn": { "type": "string", "x-go-name": "CreatedOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desc": { "type": "string", "x-go-name": "Desc", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "followRedirectSet": { "type": "string", "x-go-name": "FollowRedirectSet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "healtcheckPropertiesSetStatus": { "type": "string", "x-go-name": "HealthcheckPropertiesSetStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "healthcheckProperties": { "$ref": "#/components/schemas/HealthcheckProperties" }, "modifiedOn": { "type": "string", "x-go-name": "ModifiedOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "monitorState": { "type": "string", "x-go-name": "MonitorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbHost": { "type": "string", "x-go-name": "NlbHost", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "NlbHealthSetConfig": { "description": "NlbHealthSetConfig config for NLB Health configuration", "type": "object", "properties": { "allowInsecureSet": { "type": "string", "x-go-name": "AllowInsecureSet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdOn": { "type": "string", "x-go-name": "CreatedOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desc": { "type": "string", "x-go-name": "Desc", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "followRedirectSet": { "type": "string", "x-go-name": "FollowRedirectSet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "healtcheckPropertiesSetStatus": { "type": "string", "x-go-name": "HealthcheckPropertiesSetStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "healthcheckProperties": { "type": "object", "additionalProperties": {}, "x-go-name": "HealthcheckProperties" }, "modifiedOn": { "type": "string", "x-go-name": "ModifiedOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "monitorState": { "type": "string", "x-go-name": "MonitorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbHost": { "type": "string", "x-go-name": "NlbHost", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "NlbVPCConfig": { "description": "NlbVPCConfig is the request and response body for the v2 vpc apis", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dnsType": { "type": "string", "x-go-name": "DNSType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "lbHostname": { "type": "string", "x-go-name": "LBHostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nlbSubdomain": { "type": "string", "x-go-name": "NlbSubdomain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretNamespace": { "type": "string", "x-go-name": "SecretNamespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/vpc" }, "NlbVPCListConfig": { "description": "NlbVPCListConfig single nlb subdomain in list response", "type": "object", "properties": { "Nlb": { "$ref": "#/components/schemas/ExtendedNlbVPCConfig" }, "secretName": { "type": "string", "x-go-name": "SecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretStatus": { "type": "string", "x-go-name": "SecretStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/vpc" }, "Number": { "type": "string", "title": "A Number represents a JSON number literal.", "x-go-package": "encoding/json", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "OauthAccessTypeJSON": { "description": "OauthAccessTypeJSON for request and response", "type": "object", "properties": { "oauth_access_type": { "type": "string", "x-go-name": "OauthAccessType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "_OauthAccessTypeJSON", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "ObjectFieldSelector": { "description": "+structType=atomic", "type": "object", "title": "ObjectFieldSelector selects an APIVersioned field of an object.", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional", "type": "string", "x-go-name": "APIVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string", "x-go-name": "FieldPath", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "k8s.io/api/core/v1" }, "OperatingSystem": { "description": "OperatingSystem is the supported OS", "type": "object", "properties": { "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "isDeprecated": { "type": "boolean", "x-go-name": "IsDeprecated" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPoolCreateUnsupported": { "type": "boolean", "x-go-name": "PreventCreate" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "OutboundTrafficProtectionRequest": { "type": "object", "title": "OutboundTrafficProtectionRequest defines a request to change the outbound traffic protection for a VPC Secure By Default cluster.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operation": { "type": "string", "x-go-name": "Operation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "Permissions": { "description": "Permissions describes the result of checking granted permissions\nNote: the default zero/empty value implies sufficient permissions", "type": "object", "properties": { "recommended": { "$ref": "#/components/schemas/PermissionsAnalysis" }, "required": { "$ref": "#/components/schemas/PermissionsAnalysis" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "PermissionsAnalysis": { "description": "PermissionsAnalysis describes the result of checking granted permissions\nNote: the default zero/empty value implies sufficient permissions", "type": "object", "properties": { "insufficient": { "description": "Insufficient is true if granted permissions are insufficient\nNote: the default zero/empty value implies sufficient permissions", "type": "boolean", "x-go-name": "Insufficient" }, "missingPermissions": { "description": "MissingPermissions describes why granted permissions are insufficient,\nusing IaaS-specific terminology (e.g to present to the user in permissions\nwarning or failure messages)", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "MissingPermissions", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "PodSecurityPolicyResponse": { "description": "PodSecurityPolicyResponse represents the state of the cluster PodSecurityPolicy admission controller", "type": "object", "properties": { "enabled": { "type": "boolean", "x-go-name": "Enabled" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "PodSecurityResponse": { "description": "PodSecurityResponse represents the configuration of the cluster PodSecurity admission controller", "type": "object", "properties": { "configuration": { "description": "Configuration is a base64 encoded PodSecurityConfiguration yaml definition", "type": "string", "format": "byte", "x-go-name": "Configuration", "minLength": 1, "maxLength": 256 }, "enabled": { "type": "boolean", "x-go-name": "Enabled" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "Port80Config": { "description": "Port80Config struct models port 80 configuration", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "PreviewState": { "description": "PreviewState is a [ReleaseVersion] preview classification", "type": "string", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "PrivateServiceEndpointEnabled": { "description": "PrivateServiceEndpointEnabled is a status from the softlayer for the used account\nOR for the attached infrastructure account in the actual region", "type": "object", "properties": { "isPrivateServiceEnabled": { "type": "boolean", "x-go-name": "IsPrivateServiceEnabled" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "ProductConfig": { "description": "ProductConfig properties", "type": "object", "properties": { "company_name": { "type": "string", "x-go-name": "CompanyName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "container_service_name": { "type": "string", "x-go-name": "ContainerServiceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iaas_name": { "type": "string", "x-go-name": "IaasName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "product_name": { "type": "string", "x-go-name": "ProductName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "product_name_short": { "type": "string", "x-go-name": "ProductNameShort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "Provider": { "description": "Provider contains the name and description of providers", "type": "object", "properties": { "name": { "description": "The name of the infrastructure provider.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2" }, "Quantity": { "description": "The serialization format is:\n\n```\n ::= \n\n(Note that may be empty, from the \"\" case in .)\n\n ::= 0 | 1 | ... | 9\n ::= | \n ::= | . | . | .\n ::= \"+\" | \"-\"\n ::= | \n ::= | | \n ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n ::= m | \"\" | k | M | G | T | P | E\n\n(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n ::= \"e\" | \"E\" \n```\n\nNo matter which of the three exponent forms is used, no quantity may represent\na number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal\nplaces. Numbers larger or more precise will be capped or rounded up.\n(E.g.: 0.1m will rounded up to 1m.)\nThis may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix\nit had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\".\nThis means that Exponent/suffix will be adjusted up or down (with a\ncorresponding increase or decrease in Mantissa) such that:\n\nNo precision is lost\nNo fractional digits will be emitted\nThe exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n1.5 will be serialized as \"1500m\"\n1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a\nfloating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed,\nbut will be re-emitted in their canonical form. (So always use canonical\nform, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without\nwriting some sort of special handling code in the hopes that that will\ncause implementors to also use a fixed point implementation.\n\n+protobuf=true\n+protobuf.embed=string\n+protobuf.options.marshal=false\n+protobuf.options.(gogoproto.goproto_stringer)=false\n+k8s:deepcopy-gen=true\n+k8s:openapi-gen=true\n+k8s:openapi-model-package=io.k8s.apimachinery.pkg.api.resource", "type": "object", "title": "Quantity is a fixed-point representation of a number.\nIt provides convenient marshaling/unmarshaling in JSON and YAML,\nin addition to String() and AsInt64() accessors.", "x-go-package": "k8s.io/apimachinery/pkg/api/resource" }, "RebalanceWorkerPool": { "type": "object", "title": "RebalanceWorkerPool provides fields needed to request a worker pool rebalance.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "RefreshMaster": { "description": "RefreshMaster defines the payload required to refresh the master for a given cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "Region": { "description": "Region represnts information about a region for the cli and ui", "type": "object", "properties": { "alias": { "type": "string", "x-go-name": "Alias", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cfURL": { "type": "string", "x-go-name": "CFURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "freeEnabled": { "type": "boolean", "x-go-name": "FreeEnabled" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "satellite": { "type": "boolean", "x-go-name": "Satellite" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "Regions": { "description": "Regions represnts information about all the regions for the cli and ui", "type": "object", "properties": { "regions": { "type": "array", "items": { "$ref": "#/components/schemas/Region" }, "x-go-name": "Regions", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "RegisterConfig": { "description": "RegisterConfig the instance register request", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "secretGroupID": { "type": "string", "x-go-name": "SecretGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/instance" }, "RegisteredStorage": { "type": "object", "title": "RegisteredStorage ...", "properties": { "default-version": { "type": "string", "x-go-name": "DefaultVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "displayname": { "type": "string", "x-go-name": "DisplayName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "enabled": { "type": "string", "x-go-name": "Enabled", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredStorageVersion" }, "x-go-name": "Versions", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "RegisteredStorageVersion": { "type": "object", "title": "RegisteredStorageVersion ...", "properties": { "custom-parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParameter" }, "x-go-name": "CustomParameters", "minItems": 0, "maxItems": 100 }, "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "revision": { "type": "string", "x-go-name": "Revision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-class-parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParameter" }, "x-go-name": "StorageClassParameters", "minItems": 0, "maxItems": 100 }, "storage-class-template": { "type": "string", "x-go-name": "StorageClassTemplate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/EnvVar" }, "x-go-name": "Tags", "minItems": 0, "maxItems": 100 }, "vendor-storage-class-parameters": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "VendorStorageClassParameters", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "Registration": { "type": "object", "title": "Registration ...", "properties": { "ips": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IPs", "minItems": 0, "maxItems": 100 }, "subdomain": { "type": "string", "x-go-name": "Subdomain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "ReleaseVersion": { "description": "ReleaseVersion is a Kubernetes or OpenShift release version", "type": "object", "properties": { "default": { "type": "boolean", "x-go-name": "Default" }, "end_of_service": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "major": { "type": "integer", "format": "int64", "x-go-name": "Major", "minimum": 0, "maximum": 2147483647 }, "minor": { "type": "integer", "format": "int64", "x-go-name": "Minor", "minimum": 0, "maximum": 2147483647 }, "patch": { "type": "integer", "format": "int64", "x-go-name": "Patch", "minimum": 0, "maximum": 2147483647 }, "preview_state": { "$ref": "#/components/schemas/PreviewState" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "RemoteResources": { "type": "object", "title": "RemoteResources ...", "properties": { "cluster": { "type": "object", "properties": { "clusterId": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "Cluster" }, "lastModified": { "type": "string", "x-go-name": "LastModified", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "searchableData": { "type": "object", "properties": { "errors": { "x-go-name": "Errors" }, "kind": { "type": "string", "x-go-name": "Kind", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "searchableExpression": { "type": "string", "x-go-name": "SearchableExpression", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "SearchableData" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "RemoveCluster": { "type": "object", "title": "RemoveCluster defines a request to remove a cluster.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "deleteResources": { "type": "boolean", "x-go-name": "DeleteResources" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "RemoveDedicatedHostPool": { "type": "object", "title": "RemoveDedicatedHostPool contains the field in requests to remove a dedicated host pool instance.", "properties": { "hostPool": { "type": "string", "x-go-name": "HostPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "RemovePodSecurityRequest": { "description": "RemovePodSecurityRequest disables the cluster PodSecurity admission controller for v1.24 clusters", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "RemoveSubscriptionData": { "type": "object", "title": "RemoveSubscriptionData ...", "properties": { "removeSubscription": { "$ref": "#/components/schemas/RemoveSubscriptionType" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "RemoveSubscriptionType": { "type": "object", "title": "RemoveSubscriptionType ...", "properties": { "success": { "type": "boolean", "x-go-name": "Success" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "RemoveWorker": { "type": "object", "title": "RemoveWorker defines a request to remove a worker.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerID": { "type": "string", "x-go-name": "WorkerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "RemoveWorkerPool": { "type": "object", "title": "RemoveWorkerPool defines a request to remove a workerpool.", "properties": { "allowSingleOpenShiftWorker": { "type": "boolean", "x-go-name": "AllowSingleOpenShiftWorker" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "RemoveWorkerPoolZoneReq": { "type": "object", "title": "RemoveWorkerPoolZoneReq defines a request to remove a workerool zone.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ReplaceDefaultSubdomainReq": { "description": "ReplaceDefaultSubdomainReq is the request body for replacing default subdomain for cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subdomain": { "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "ReplaceWorkerRequest": { "type": "object", "title": "ReplaceWorkerRequest defines a request to replace a worker.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "update": { "type": "boolean", "x-go-name": "Update" }, "workerID": { "type": "string", "x-go-name": "WorkerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "ResetAPIKeyResponse": { "description": "ResetAPIKey returns 204 unless the api key UUID is requested via showKeyUUID=true", "type": "object", "title": "ResetAPIKeyResponse is data optionally returned by a ResetAPIKey request call.", "properties": { "apiKeyUUID": { "type": "string", "x-go-name": "APIKeyUUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "ResizeWorkerPool": { "type": "object", "title": "ResizeWorkerPool defines a request to resize a worker pool.", "properties": { "allowSingleOpenShiftWorker": { "type": "boolean", "x-go-name": "AllowSingleOpenShiftWorker" }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "size": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ResourceFieldSelector": { "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format\n+structType=atomic", "type": "object", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars\n+optional", "type": "string", "x-go-name": "ContainerName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "divisor": { "$ref": "#/components/schemas/Quantity" }, "resource": { "description": "Required: resource to select", "type": "string", "x-go-name": "Resource", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "k8s.io/api/core/v1" }, "ResponseErrors": { "description": "ResponseErrors are used to communicate to non-critical errors to end users", "type": "object", "properties": { "incidentID": { "type": "string", "x-go-name": "ReqID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorBase" }, "x-go-name": "Items", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/errors" }, "RevisionDetails": { "type": "object", "title": "RevisionDetails ...", "properties": { "cves": { "type": "string", "x-go-name": "CVEs", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "fixes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Fixes", "minItems": 0, "maxItems": 100 }, "golang": { "type": "string", "x-go-name": "GoLang", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "new-features": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "NewFeatures", "minItems": 0, "maxItems": 100 }, "release-date": { "type": "string", "x-go-name": "ReleaseDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "revision": { "type": "string", "x-go-name": "Revision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ubi": { "type": "string", "x-go-name": "UBI", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "RevisionLogForVersionResp": { "type": "object", "title": "RevisionLogForVersionResp ...", "properties": { "latest-revision": { "$ref": "#/components/schemas/RevisionDetails" }, "previous-revision": { "$ref": "#/components/schemas/RevisionDetails" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "SatClusterStorageRequest": { "description": "SatClusterStorageRequest is the input or respose format for service flow APIs", "type": "object", "properties": { "clusterID": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-requests": { "type": "array", "items": { "$ref": "#/components/schemas/DesiredAttributes" }, "x-go-name": "StorageRequests", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "SatelliteACLResponse": { "description": "SatelliteACLResponse response for GET request", "type": "object", "properties": { "actualCSEACLList": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "ActualACLList", "minItems": 0, "maxItems": 100 }, "desiredCSEACLList": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "DesiredACLList", "minItems": 0, "maxItems": 100 } }, "x-go-name": "_SatelliteACLResponse", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "SatelliteClusterFragment": { "description": "SatelliteClusterFragment is a satellite cluster specific data", "type": "object", "properties": { "infrastructureTopology": { "type": "string", "x-go-name": "InfrastructureTopology", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "locationEndpointURL": { "type": "string", "x-go-name": "LocationEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "satellitePrivateEndpointURL": { "type": "string", "x-go-name": "SatellitePrivateEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/multishift" }, "SatelliteCreateWorkerPoolFragment": { "type": "object", "title": "SatelliteCreateWorkerPoolFragment contains the fields necessary to request a satellite worker pool.", "properties": { "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "SatelliteCreateWorkerPoolZone": { "description": "SatelliteCreateWorkerPoolZone contains all fields in the zones part of\nall requests to create worker pools.", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "SatelliteWorkerPoolZoneAdd": { "description": "SatelliteWorkerPoolZoneAdd defines the request body for a satellite worker pool zone add request", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "SatelliteWorkerPoolZoneAddFragment": { "description": "SatelliteWorkerPoolZoneAddFragment contains fields unique to Satellite clusters", "type": "object", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "Secret": { "description": "Secret struct holding details for a single secret", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domain": { "description": "deprecated: use \"Domains\" instead", "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Domains", "minItems": 0, "maxItems": 100 }, "expiresOn": { "type": "string", "x-go-name": "ExpiresOn", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "fields": { "$ref": "#/components/schemas/Fields" }, "lastUpdatedTimestamp": { "type": "string", "x-go-name": "LastUpdatedTimestamp", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "persistence": { "type": "boolean", "x-go-name": "Persistence" }, "secretType": { "type": "string", "x-go-name": "SecretType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "userManaged": { "type": "boolean", "x-go-name": "UserManaged" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret" }, "SecretConfig": { "description": "SecretConfig config for deleting secrets", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subdomain": { "type": "string", "x-go-name": "Subdomain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "SecretKeySelector": { "description": "+structType=atomic", "type": "object", "title": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string", "x-go-name": "Key", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "optional": { "description": "Specify whether the Secret or its key must be defined\n+optional", "type": "boolean", "x-go-name": "Optional" } }, "x-go-package": "k8s.io/api/core/v1" }, "Secrets": { "description": "Secrets struct for a secret array", "type": "array", "items": { "$ref": "#/components/schemas/Secret" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret", "minItems": 0, "maxItems": 100 }, "SecurityGroupRequest": { "type": "object", "title": "SecurityGroupRequest defines a request to reset or sync security group rules.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operation": { "type": "string", "x-go-name": "Operation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "securityGroupID": { "type": "string", "x-go-name": "SecurityGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "ServiceBindRequest": { "description": "ServiceBindRequest is the format for a service bind request", "type": "object", "properties": { "namespaceID": { "type": "string", "x-go-name": "NamespaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "x-go-name": "Role", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceInstanceGUID": { "type": "string", "x-go-name": "ServiceInstanceNameOrID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceKeyGUID": { "type": "string", "x-go-name": "ServiceKeyGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceKeyJSON": { "type": "string", "x-go-name": "ServiceKeyJSON", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "ServiceBindResponse": { "description": "ServiceBindResponse is the response format for a service bind request", "type": "object", "properties": { "binding": { "type": "string", "x-go-name": "Binding", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespaceID": { "type": "string", "x-go-name": "NamespaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretName": { "type": "string", "x-go-name": "SecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceInstanceGUID": { "type": "string", "x-go-name": "ServiceInstanceGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "ServiceClusterFragment": { "description": "ServiceClusterFragment is service cluster specific data", "type": "object", "properties": { "serviceID": { "type": "string", "x-go-name": "ServiceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceName": { "type": "string", "x-go-name": "ServiceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/multishift" }, "ServiceUnbindResponse": { "description": "ServiceUnbindResponse is the response format for a service unbind request", "type": "object", "properties": { "serviceKeyGUID": { "type": "string", "x-go-name": "ServiceKeyGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceKeyShouldBeDeleted": { "type": "boolean", "x-go-name": "ServiceKeyShouldBeDeleted" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "SetAssignmentAutoupgradeInputData": { "type": "object", "title": "SetAssignmentAutoupgradeInputData ...", "properties": { "assignment": { "type": "object", "properties": { "all": { "type": "boolean", "x-go-name": "All" }, "uuids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UUIDs", "minItems": 0, "maxItems": 100 } }, "x-go-name": "Assignment" }, "autoUpgrade": { "type": "boolean", "x-go-name": "AutoUpgrade" }, "config": { "type": "string", "x-go-name": "Config", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "SetDesiredStorageConfigRequest": { "description": "SetDesiredStorageConfigRequest is the request body for setDesiredStorageConfig API", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-requests": { "$ref": "#/components/schemas/DesiredAttributes" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "SetDesiredStorageConfigResponse": { "description": "SetDesiredStorageConfigResponse is the response body of satellite/setDesiredStorageConfig API", "type": "object", "properties": { "request-id": { "type": "string", "x-go-name": "RequestID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "SetMonitorReq": { "description": "SetMonitorReq is used to set domain monitor request body for new domain update API", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domain": { "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "health_monitor_properties": { "$ref": "#/components/schemas/HealthMonitorProperties" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "SetPodSecurityRequest": { "description": "SetPodSecurityRequest configures the cluster PodSecurity admission controller", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "configuration": { "description": "Optional: A base64 encoded Kubernetes PodSecurityConfiguration yaml definition.\nIf configuration is present the specified custom configuration will be used.\nIf configuration is not present the default Kubernetes configuration will be used.", "type": "string", "format": "byte", "x-go-name": "Configuration", "minLength": 1, "maxLength": 256 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "SetWorkerPoolLabels": { "type": "object", "title": "SetWorkerPoolLabels provides label key and value pairs to set on a worker pool.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "SetWorkerPoolOperatingSystem": { "type": "object", "title": "SetWorkerPoolOperatingSystem defines a request to set the operating system of a worker pool.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "SetWorkerPoolTaints": { "type": "object", "title": "SetWorkerPoolTaints provides taint key and value pairs to set on a worker pool.", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "taints": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Taints" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "SingleClassicClusterCommon": { "description": "SingleClassicClusterCommon is data returned that is specific to a classic cluster", "type": "object", "properties": { "monitoringURL": { "type": "string", "x-go-name": "MonitoringURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vlans": { "type": "array", "items": { "$ref": "#/components/schemas/VlanConfigField" }, "x-go-name": "SubnetVLANs", "minItems": 0, "maxItems": 100 }, "worker_vlans": { "$ref": "#/components/schemas/VLANS" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "SingleClusterCommon": { "description": "SingleClusterCommon provides additional information when clusters\nare retrieved individually.", "type": "object", "properties": { "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableAutoUpdate": { "type": "boolean", "x-go-name": "DisableAutoUpdate" }, "ignitionServerURL": { "type": "string", "x-go-name": "IgnitionServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "konnectivityServerURL": { "type": "string", "x-go-name": "KonnectivityServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "locationZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "LocationZones", "minItems": 0, "maxItems": 100 }, "oauthServerURL": { "type": "string", "x-go-name": "OauthServerURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "supportedOperatingSystems": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SupportedOperatingSystems", "minItems": 0, "maxItems": 100 }, "workerZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "WorkerZones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "Status": { "description": "Status struct for the top level ingress status, for a cluster", "type": "object", "properties": { "StatusList": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentStatus" }, "minItems": 0, "maxItems": 100 }, "albStatus": { "type": "array", "items": { "$ref": "#/components/schemas/V2ComponentStatus" }, "x-go-name": "ALBStatus", "minItems": 0, "maxItems": 100 }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "enabled": { "type": "boolean", "x-go-name": "Enabled" }, "generalComponentStatus": { "type": "array", "items": { "$ref": "#/components/schemas/V2ComponentStatus" }, "x-go-name": "GeneralComponentStatus", "minItems": 0, "maxItems": 100 }, "ignoredErrors": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IgnoredErrors", "minItems": 0, "maxItems": 100 }, "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "nonTranslatedStatus": { "type": "string", "x-go-name": "NonTranslatedStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "routerStatus": { "type": "array", "items": { "$ref": "#/components/schemas/V2ComponentStatus" }, "x-go-name": "RouterStatus", "minItems": 0, "maxItems": 100 }, "secretStatus": { "type": "array", "items": { "$ref": "#/components/schemas/V2ComponentStatus" }, "x-go-name": "SecretStatus", "minItems": 0, "maxItems": 100 }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subdomainStatus": { "type": "array", "items": { "$ref": "#/components/schemas/V2ComponentStatus" }, "x-go-name": "SubdomainStatus", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress-status" }, "StatusState": { "description": "StatusState status of ingress status", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "enable": { "type": "boolean", "x-go-name": "Enable" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress-status" }, "StorageConfig": { "type": "object", "title": "StorageConfig ...", "properties": { "config-name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "config-version": { "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "created": { "type": "string", "x-go-name": "Created", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "is-revision-update-available": { "type": "boolean", "x-go-name": "IsRevisionUpdateAvailable" }, "is-user-secret-parameters-set": { "type": "object", "additionalProperties": { "type": "boolean" }, "x-go-name": "IsUserSecretParamtersSet" }, "latest-revision": { "type": "string", "x-go-name": "LatestRevision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "orgId": { "type": "string", "x-go-name": "OrgID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "revision": { "type": "string", "x-go-name": "Revision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-class-parameters": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "StorageClassParamters", "minItems": 0, "maxItems": 100 }, "storage-template-metadata": { "$ref": "#/components/schemas/ConfigAttributes" }, "storage-template-name": { "type": "string", "x-go-name": "StorageTemplateName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-template-version": { "type": "string", "x-go-name": "StorageTemplateVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigSubscriptionInfo" }, "x-go-name": "Subscriptions", "minItems": 0, "maxItems": 100 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Tags", "minItems": 0, "maxItems": 100 }, "template-status": { "type": "string", "x-go-name": "TemplateStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "user-config-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserConfigParamters" }, "user-secret-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserSecretParamters" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "StorageConfigCreateInput": { "description": "StorageConfigCreateInput is the input payload struct for create storage configuration API", "type": "object", "properties": { "config-name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-class-parameters": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "StorageClassParamters", "minItems": 0, "maxItems": 100 }, "storage-template-name": { "type": "string", "x-go-name": "StorageTemplateName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-template-version": { "type": "string", "x-go-name": "StorageTemplateVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "user-config-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserConfigParamters" }, "user-secret-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserSecretParamters" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "StorageConfigData": { "description": "StorageConfigData contains the common parameters for create & update storage configuration API input payloads", "type": "object", "properties": { "config-name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-class-parameters": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "StorageClassParamters", "minItems": 0, "maxItems": 100 }, "user-config-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserConfigParamters" }, "user-secret-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserSecretParamters" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "StorageConfigUpdateInput": { "description": "StorageConfigUpdateInput is the input payload struct for update storage configuration API", "type": "object", "properties": { "config-name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "controller": { "type": "string", "x-go-name": "Controller", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-class-parameters": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "StorageClassParamters", "minItems": 0, "maxItems": 100 }, "update-assignments": { "type": "boolean", "x-go-name": "UpdateAssignments" }, "user-config-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserConfigParamters" }, "user-secret-parameters": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "UserSecretParamters" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "StorageRequest": { "description": "StorageRequest defines a storage request", "type": "object", "properties": { "assignment": { "type": "string", "x-go-name": "Assignment", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "backend": { "$ref": "#/components/schemas/StorageRequestBackendData" }, "config": { "$ref": "#/components/schemas/StorageRequestConfigData" }, "request-id": { "type": "string", "x-go-name": "RequestID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "StorageRequestBackendData": { "description": "StorageRequestBackendData defines information related to storage backend", "type": "object", "properties": { "attribute": { "$ref": "#/components/schemas/BackendAttributes" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "StorageRequestConfigData": { "description": "StorageRequestConfigData defines information related to storage configuration and assignment", "type": "object", "properties": { "attribute": { "$ref": "#/components/schemas/ConfigAttributes" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "StorageTemplateVersionResp": { "type": "object", "title": "StorageTemplateVersionResp ...", "properties": { "custom-parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParameter" }, "x-go-name": "CustomParameters", "minItems": 0, "maxItems": 100 }, "description": { "type": "string", "x-go-name": "Description", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "displayname": { "type": "string", "x-go-name": "DisplayName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "enabled": { "type": "string", "x-go-name": "Enabled", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "revision": { "type": "string", "x-go-name": "Revision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storage-class-parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CustomParameter" }, "x-go-name": "StorageClassParameters", "minItems": 0, "maxItems": 100 }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/EnvVar" }, "x-go-name": "Tags", "minItems": 0, "maxItems": 100 }, "vendor-storage-class-parameters": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "VendorStorageClassParameters", "minItems": 0, "maxItems": 100 }, "version": { "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version-description": { "type": "string", "x-go-name": "VersionDescription", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "Subnet": { "description": "Subnet provides information about a vpc subnet", "type": "object", "properties": { "availableIPv4AddressCount": { "type": "integer", "format": "int64", "x-go-name": "AvailableIPv4AddressCount", "minimum": 0, "maximum": 2147483647 }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ipv4CIDRBlock": { "type": "string", "x-go-name": "IPv4CIDR", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicGatewayID": { "type": "string", "x-go-name": "PublicGatewayID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicGatewayName": { "type": "string", "x-go-name": "PublicGatewayName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcName": { "type": "string", "x-go-name": "VPCName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "SubnetConfigField": { "description": "SubnetConfigField represents a subnet config for a VLAN config, including properties like IP addresses, if it's public, BYOIP, and the subnet CIDR", "type": "object", "properties": { "cidr": { "type": "string", "x-go-name": "CIDR", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ips": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Ips", "minItems": 0, "maxItems": 100 }, "is_byoip": { "type": "boolean", "x-go-name": "IsBYOIP" }, "is_public": { "type": "boolean", "x-go-name": "IsPublic" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model" }, "SubnetProperties": { "description": "SubnetProperties contains SoftLater-specific properties for subnets", "type": "object", "properties": { "bound_cluster": { "type": "string", "x-go-name": "BoundCluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cidr": { "type": "string", "x-go-name": "CIDR", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "datacenter": { "type": "string", "x-go-name": "DataCenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "display_label": { "type": "string", "x-go-name": "DisplayLabel", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "gateway": { "type": "string", "x-go-name": "Gateway", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "network_identifier": { "type": "string", "x-go-name": "NetworkIdentifier", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "note": { "type": "string", "x-go-name": "Note", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnet_type": { "type": "string", "x-go-name": "SubnetType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "Subnets": { "type": "array", "title": "Subnets is a sortable array of Subnet instances.", "items": { "$ref": "#/components/schemas/Subnet" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc", "minItems": 0, "maxItems": 100 }, "Subscription": { "description": "Subscription contains the details of a subscription\nRazeedash-api link: https://github.com/razee-io/Razeedash-api/blob/master/app/apollo/schema/subscription.js#L40-L59", "type": "object", "properties": { "channelName": { "type": "string", "x-go-name": "ChannelName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "channelUuid": { "type": "string", "x-go-name": "ChannelUUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterName": { "type": "string", "x-go-name": "ClusterName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "configRevisionStatus": { "type": "object", "properties": { "isRevisionUpdateAvailable": { "type": "boolean", "x-go-name": "IsRevisionUpdateAvailable" }, "latestRevision": { "type": "string", "x-go-name": "LatestRevision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "revision": { "type": "string", "x-go-name": "Revision", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "ConfigRevisionStatus" }, "created": { "type": "string", "x-go-name": "Created", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "groups": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Groups", "minItems": 0, "maxItems": 100 }, "isAssignmentUpgradeAvailable": { "type": "boolean", "x-go-name": "IsAssignmentUpgradeAvailable" }, "isAutoUpgradeEnabled": { "type": "boolean", "x-go-name": "IsAutoUpgradeEnabled" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "orgId": { "type": "string", "x-go-name": "OrgID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "owner": { "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "Owner" }, "remoteResources": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteResources" }, "x-go-name": "RemoteResources", "minItems": 0, "maxItems": 100 }, "rolloutStatus": { "type": "object", "properties": { "errorCount": { "type": "integer", "format": "int64", "x-go-name": "ErrorCount", "minimum": 0, "maximum": 2147483647 }, "successCount": { "type": "integer", "format": "int64", "x-go-name": "SuccessCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-name": "RolloutStatus" }, "satSvcClusterId": { "type": "string", "x-go-name": "SatelliteSvcClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "satcluster": { "type": "string", "x-go-name": "SatelliteClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subscriptionType": { "type": "string", "x-go-name": "SubscriptionType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "updated": { "type": "string", "x-go-name": "Updated", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "version": { "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionUuid": { "type": "string", "x-go-name": "VersionUUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "SupportedOperatingSystems": { "description": "SupportedOperatingSystems contains the list of supported OSes", "type": "object", "properties": { "kubernetes": { "type": "array", "items": { "$ref": "#/components/schemas/OperatingSystem" }, "x-go-name": "Kubernetes", "minItems": 0, "maxItems": 100 }, "openshift": { "type": "array", "items": { "$ref": "#/components/schemas/OperatingSystem" }, "x-go-name": "Openshift", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "TemplateAttributes": { "description": "TemplateAttributes are the various attributes of a storage template", "type": "object", "properties": { "offering-type": { "type": "string", "x-go-name": "OfferingType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storageclasses": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "StorageClasses", "minItems": 0, "maxItems": 100 }, "volume-availability": { "type": "string", "x-go-name": "VolumeAvailability", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-encryption-at-rest": { "type": "string", "x-go-name": "VolumeEncryptionAtRest", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-expansion": { "type": "string", "x-go-name": "VolumeExpansion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-snapshot": { "type": "string", "x-go-name": "VolumeSnapshot", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume-type": { "type": "string", "x-go-name": "VolumeType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "UnbindService": { "description": "UnbindService defines a request to bind a service to a cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespaceID": { "type": "string", "x-go-name": "NamespaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceInstanceNameOrID": { "type": "string", "x-go-name": "ServiceInstanceNameOrID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "UnsatisfiedLabels": { "description": "UnsatisfiedLabels describes any host labels that must be created to fulfill pending worker pool assignments", "type": "object", "properties": { "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Label" }, "x-go-name": "Labels", "minItems": 0, "maxItems": 100 }, "pending": { "type": "integer", "format": "int64", "x-go-name": "Pending", "minimum": 0, "maximum": 2147483647 }, "workerPoolID": { "type": "string", "x-go-name": "WorkerPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPoolName": { "type": "string", "x-go-name": "WorkerPoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "UnsetMonitorReq": { "description": "UnsetMonitorReq is used to unset domain monitor request body for new domain update API", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domain": { "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "UpdateConfig": { "description": "UpdateConfig the secret update request", "type": "object", "properties": { "add": { "type": "array", "items": { "$ref": "#/components/schemas/FieldAdd" }, "x-go-name": "FieldsToAdd", "minItems": 0, "maxItems": 100 }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespace": { "type": "string", "x-go-name": "Namespace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "remove": { "type": "array", "items": { "$ref": "#/components/schemas/FieldRemove" }, "x-go-name": "FieldsToRemove", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/secret" }, "UpdateDedicatedHost": { "type": "object", "title": "UpdateDedicatedHost contains the fields necessary to update a dedicated host.", "properties": { "hostID": { "type": "string", "x-go-name": "HostID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPoolID": { "type": "string", "x-go-name": "HostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "UpdateDomainReq": { "description": "UpdateDomainReq request body for new domain update API", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "domain": { "type": "string", "x-go-name": "Domain", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostname": { "type": "string", "x-go-name": "Hostname", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ips": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "IPs", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/dns" }, "UpdateMaster": { "description": "UpdateMaster provides the information for updating a cluster's master", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "force": { "type": "boolean", "x-go-name": "Force" }, "version": { "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "UpdateMasterCommand": { "type": "object", "title": "UpdateMasterCommand represents a generic master action. Possible actions include 'update'.", "properties": { "action": { "description": "The action to perform on the master.", "type": "string", "x-go-name": "Action", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "force": { "description": "If set to true, any warnings during the update process are ignored.", "type": "boolean", "x-go-name": "Force" }, "version": { "description": "The Kubernetes version to use for the update.", "type": "string", "x-go-name": "Version", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "UpdatePolicy": { "type": "object", "title": "UpdatePolicy represents the body for interacting with the update logging APIs.", "properties": { "autoUpdate": { "description": "If set to `true`, the cluster is enabled for automatic updates.", "type": "boolean", "x-go-name": "AutoUpdate" }, "latestVersion": { "description": "If set to `true`, the cluster log forwarder runs the latest version.", "type": "boolean", "x-go-name": "LatestVersion" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/logging" }, "UpdateServiceEndpoint": { "description": "UpdateServiceEndpoint contains a service endpoint update request for a cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "UpdateSubscriptionData": { "type": "object", "title": "UpdateSubscriptionData ...", "properties": { "editSubscription": { "$ref": "#/components/schemas/UpdateSubscriptionType" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "UpdateSubscriptionInputData": { "type": "object", "title": "UpdateSubscriptionInputData ...", "properties": { "groups": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Groups", "minItems": 0, "maxItems": 100 }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "updateConfigVersion": { "type": "boolean", "x-go-name": "UpdateConfigVersion" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "UpdateSubscriptionType": { "type": "object", "title": "UpdateSubscriptionType ...", "properties": { "success": { "type": "boolean", "x-go-name": "Success" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "UpdateSubscriptionVersionData": { "type": "object", "title": "UpdateSubscriptionVersionData ...", "properties": { "setSubscription": { "$ref": "#/components/schemas/UpdateSubscriptionVersionType" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "UpdateSubscriptionVersionInputData": { "type": "object", "title": "UpdateSubscriptionVersionInputData ...", "properties": { "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionUuid": { "type": "string", "x-go-name": "VersionUUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "UpdateSubscriptionVersionType": { "type": "object", "title": "UpdateSubscriptionVersionType ...", "properties": { "success": { "type": "boolean", "x-go-name": "Success" }, "uuid": { "type": "string", "x-go-name": "UUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/razee" }, "UpdateWorkerCommand": { "type": "object", "title": "UpdateWorkerCommand represents a generic worker action and if it was forced. Possible actions include 'os_reboot' and 'reload'.", "properties": { "action": { "description": "The action to perform on the worker node.", "type": "string", "x-go-name": "Action", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "force": { "description": "Setting force flag to true will ignore if the master is unavailable during 'os_reboot\" and 'reload' action", "type": "boolean", "x-go-name": "Force" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "UserConfig": { "description": "UserConfig describes the config values applicable to a user account", "type": "object", "properties": { "freeEnabled": { "type": "boolean", "x-go-name": "FreeEnabled" }, "storedIaasCredentials": { "type": "boolean", "x-go-name": "StoredIaasCredentials" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "UserError": { "description": "UserError user error", "type": "object", "properties": { "code": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "description": { "type": "string", "x-go-name": "Err", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "rc": { "type": "integer", "format": "int64", "x-go-name": "RC", "minimum": 0, "maximum": 2147483647 }, "recoveryCLI": { "type": "string", "x-go-name": "RecoveryCLI", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "terseDescription": { "type": "string", "x-go-name": "TerseErr", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "$ref": "#/components/schemas/ErrorType" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/errors" }, "UserMessage": { "description": "UserMessage is used to provide human-readable text to convey useful, non-error\ninformation to users when a request was successfully completed.", "type": "object", "properties": { "level": { "$ref": "#/components/schemas/MessageLevel" }, "text": { "type": "string", "x-go-name": "Text", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "UserMessageResponse": { "description": "UserMessageResponse is a user message returned from the API", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "message": { "type": "string", "x-go-name": "Message", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "UserSubnet": { "description": "UserSubnet contains properties for user subnets", "type": "object", "properties": { "cidr": { "description": "The subnet and the CIDR that you want to add to the cluster in the format 12.34.45.78/24.", "type": "string", "x-go-name": "CIDR", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vlan_id": { "description": "The private VLAN ID that the subnet CIDR belongs to.", "type": "string", "x-go-name": "VLANID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "V2BindServiceRequest": { "description": "BindService defines a request to bind a service to a cluster", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespaceID": { "type": "string", "x-go-name": "NamespaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "role": { "type": "string", "x-go-name": "Role", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceInstanceNameOrID": { "type": "string", "x-go-name": "ServiceInstanceNameOrID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceKeyGUID": { "type": "string", "x-go-name": "ServiceKeyGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceKeyJSON": { "type": "string", "x-go-name": "ServiceKeyJSON", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "BindService", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "V2BindServiceResponse": { "description": "BindService defines a response when binding a service to a cluster", "type": "object", "properties": { "binding": { "type": "string", "x-go-name": "Binding", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "namespaceID": { "type": "string", "x-go-name": "NamespaceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secretName": { "type": "string", "x-go-name": "SecretName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceInstanceGUID": { "type": "string", "x-go-name": "ServiceInstanceGUID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "BindService", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "V2ComponentStatus": { "description": "V2ComponentStatus status of individual ingress component", "type": "object", "properties": { "component": { "type": "string", "x-go-name": "Component", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Status", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress-status" }, "V2Migration": { "description": "V2Migration is the request body of the v2 Migration API endpoint", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "options": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Options", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "V2NlbList": { "description": "V2NlbList response for the get api for vpc clusters", "type": "array", "items": { "$ref": "#/components/schemas/NlbVPCListConfig" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/vpc", "minItems": 0, "maxItems": 100 }, "V2UpdateALB": { "description": "V2UpdateALB is the body of the v2 Update ALB API endpoint", "type": "object", "properties": { "albBuild": { "type": "string", "x-go-name": "ALBBuild", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "albList": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "ALBList", "minItems": 0, "maxItems": 100 }, "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-dns-model/v2/ingress" }, "VLAN": { "type": "object", "title": "VLAN represents a singular softlayer vlan.", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "properties": { "$ref": "#/components/schemas/VLANProperties" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "VLANProperties": { "type": "object", "title": "VLANProperties stores various properities related to a softlayer vlan.", "properties": { "local_disk_storage_capability": { "type": "string", "x-go-name": "LocalDiskCapability", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "note": { "type": "string", "x-go-name": "Note", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "primary_router": { "type": "string", "x-go-name": "PrimaryRouter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "san_storage_capability": { "type": "string", "x-go-name": "SanStorageCapability", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnet_count": { "type": "integer", "format": "int64", "x-go-name": "SubnetCount", "minimum": 0, "maximum": 2147483647 }, "vlan_number": { "type": "string", "x-go-name": "VLANNumber", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vlan_type": { "type": "string", "x-go-name": "VLANType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "VLANS": { "description": "VLANS is a helper type to sort an api.VLAN list. The VLANS\nwill sort the list in order of the Properties.PrimaryRouter value so\nthat VLAN's of a common router are listed consecutively.", "type": "array", "items": { "$ref": "#/components/schemas/VLAN" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic", "minItems": 0, "maxItems": 100 }, "VMWareCredential": { "description": "VMWareCredential required to communicate with VMWare services", "type": "object", "properties": { "password": { "type": "string", "x-go-name": "Password", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "username": { "type": "string", "x-go-name": "Username", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vcenter_url": { "type": "string", "x-go-name": "VCenterURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/multishift" }, "VPCCreateCluster": { "type": "object", "title": "VPCCreateCluster contains the fields necessary to request a VPC cluster.", "properties": { "cosInstanceCRN": { "type": "string", "x-go-name": "COSInstanceCRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "cseACLEnabled": { "type": "boolean", "x-go-name": "CSEACLEnabled" }, "defaultWorkerPoolEntitlement": { "type": "string", "x-go-name": "DefaultWorkerPoolEntitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableOutboundTrafficProtection": { "type": "boolean", "x-go-name": "DisableOutboundTrafficProtection" }, "disablePublicServiceEndpoint": { "type": "boolean", "x-go-name": "DisablePublicServiceEndpoint" }, "infrastructureTopology": { "type": "string", "x-go-name": "InfrastructureTopology", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "type": "string", "x-go-name": "KubeVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "previews": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Previews", "minItems": 0, "maxItems": 100 }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "requestSecure": { "type": "boolean", "x-go-name": "RequestSecure" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerPool": { "$ref": "#/components/schemas/VPCCreateClusterWorkerPool" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateClusterFragment": { "description": "VPCCreateClusterFragment contains the fields specific to VPC create cluster\nrequests.", "type": "object", "properties": { "cosInstanceCRN": { "type": "string", "x-go-name": "COSInstanceCRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "disableOutboundTrafficProtection": { "type": "boolean", "x-go-name": "DisableOutboundTrafficProtection" }, "infrastructureTopology": { "type": "string", "x-go-name": "InfrastructureTopology", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "previews": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Previews", "minItems": 0, "maxItems": 100 }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateClusterWorkerPool": { "description": "VPCCreateClusterWorkerPool is the vpc version of the worker pool part of a create cluster\nrequest.", "type": "object", "properties": { "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPoolID": { "type": "string", "x-go-name": "HostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageOption": { "type": "string", "x-go-name": "SecondaryStorageOption", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/VPCCreateClusterWorkerPoolZone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateClusterWorkerPoolFragment": { "description": "VPCCreateClusterWorkerPoolFragment contains the fields specific to the worker pool\npart of VPC create cluster requests.", "type": "object", "properties": { "hostPoolID": { "type": "string", "x-go-name": "HostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageOption": { "type": "string", "x-go-name": "SecondaryStorageOption", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateClusterWorkerPoolZone": { "description": "VPCCreateClusterWorkerPoolZone is the vpc version of the worker pool zone part of a create\ncluster request.", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateClusterWorkerPoolZoneFragment": { "description": "VPCCreateClusterWorkerPoolZoneFragment contains the fields specific to the worker pool\nzone part of VPC create cluster requests.", "type": "object", "properties": { "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateWorkerPoolFragment": { "type": "object", "title": "VPCCreateWorkerPoolFragment contains the fields necessary to request a VPC worker pool.", "properties": { "hostPool": { "type": "string", "x-go-name": "HostPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageOption": { "type": "string", "x-go-name": "SecondaryStorageOption", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateWorkerPoolZone": { "description": "VPCCreateWorkerPoolZone contains all fields in the zones part of\nall requests to create worker pools.", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCCreateWorkerPoolZoneFragment": { "type": "object", "title": "VPCCreateWorkerPoolZoneFragment contains the zone fields necessary to request a VPC worker pool.", "properties": { "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCVolumeAttachmentConfig": { "description": "VPCVolumeAttachmentConfig is the config for the VPC volume attachment", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "ClusterID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volumeAttachmentID": { "type": "string", "x-go-name": "VolumeAttachmentID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volumeID": { "type": "string", "x-go-name": "VolumeID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "worker": { "type": "string", "x-go-name": "WorkerID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/vpc" }, "VPCWorkerPoolZoneAdd": { "description": "VPCWorkerPoolZoneAdd is the vpc part of the createWorkerPoolZone request", "type": "object", "properties": { "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerpool": { "type": "string", "x-go-name": "WorkerPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "VPCWorkerPoolZoneAddFragment": { "description": "VPCWorkerPoolZoneAddFragment contains fields unique to VPC", "type": "object", "properties": { "subnetID": { "type": "string", "x-go-name": "SubnetID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "Validator": { "type": "object", "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/satellite" }, "VirtualPrivateCloudResponse": { "description": "Using the full name to avoid the linter complaining about stutter.", "type": "object", "title": "VirtualPrivateCloudResponse provides information about a virtual private cloud.", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroup", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "VirtualPrivateCloudSingleClusterCommon": { "description": "VirtualPrivateCloudSingleClusterCommon is data returned that is specific to a vpc cluster", "type": "object", "properties": { "networkPlugin": { "type": "string", "x-go-name": "NetworkPlugin", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "outboundTrafficProtection": { "type": "string", "x-go-name": "OutboundTrafficProtection", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secureByDefault": { "type": "string", "x-go-name": "SecureByDefault", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "virtualPrivateEndpointURL": { "type": "string", "x-go-name": "VirtualPrivateEndpointURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "vpcs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "VPCs", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "VirtualPrivateClouds": { "type": "array", "title": "VirtualPrivateClouds is a sortable array of VirtualPrivateCloudResponse instances.", "items": { "$ref": "#/components/schemas/VirtualPrivateCloudResponse" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc", "minItems": 0, "maxItems": 100 }, "VlanConfigField": { "description": "VlanConfigField TODO provide meaningful comment", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "subnets": { "type": "array", "items": { "$ref": "#/components/schemas/SubnetConfigField" }, "x-go-name": "Subnets", "minItems": 0, "maxItems": 100 }, "zone": { "type": "string", "x-go-name": "Zone", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "VlanSpan": { "type": "object", "title": "VlanSpan the vlan spanning flag.", "properties": { "enabled": { "type": "boolean", "x-go-name": "Enabled" }, "modifiedDate": { "type": "string", "x-go-name": "ModifiedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "Volume": { "description": "Volume Volume create/update/delete request", "type": "object", "properties": { "accountId": { "description": "AccountID ...", "type": "string", "x-go-name": "AccountID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "capacity": { "description": "Capacity in GB", "type": "integer", "format": "int64", "x-go-name": "Capacity", "minimum": 0, "maximum": 2147483647 }, "cluster": { "description": "Cluster thiss volume belongs to", "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "clusterstatus": { "description": "ClusterStatus ... status of the associated cluster, if any", "type": "string", "x-go-name": "ClusterStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "created_at": { "description": "CreatedDate ... volume created date", "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "crn": { "description": "CRN ...", "type": "string", "x-go-name": "CRN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "datacenter": { "description": "Datacenter ...", "type": "string", "x-go-name": "Datacenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "delete_cluster_resources": { "description": "DeleteClusterResources ...", "type": "string", "x-go-name": "DeleteClusterResources", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "encryption": { "description": "Encryption ...", "type": "string", "x-go-name": "Encryption", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "description": "ID .. id is of a volume", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "iops": { "$ref": "#/components/schemas/Number" }, "name": { "description": "Name .. Name of the volume", "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "ns": { "description": "NameSpace ...", "type": "string", "x-go-name": "NameSpace", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "description": "Provider classic, vpc, vpc-classic", "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pv": { "description": "PV ...", "type": "string", "x-go-name": "PV", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pvc": { "description": "PVC ...", "type": "string", "x-go-name": "PVC", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reclaim": { "description": "ReclaimPolicy ...", "type": "string", "x-go-name": "ReclaimPolicy", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "description": "Region ...", "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupId": { "description": "ResourceGroupID ...", "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "description": "Volume status Created/Deleted/Updated", "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "storageclass": { "description": "StorageClass ...", "type": "string", "x-go-name": "StorageClass", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "tags": { "description": "Volume tags to be addedin GHoST", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Tags", "minItems": 0, "maxItems": 100 }, "volume_type": { "description": "VolumeType file , block, object", "type": "string", "x-go-name": "VolumeType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2" }, "VolumeAttachment": { "type": "object", "title": "VolumeAttachment ...", "properties": { "device": { "$ref": "#/components/schemas/Device" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume": { "$ref": "#/components/schemas/Volume" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/vpc" }, "VolumeAttachmentList": { "type": "object", "title": "VolumeAttachmentList ...", "properties": { "volume_attachments": { "type": "array", "items": { "$ref": "#/components/schemas/VolumeAttachment" }, "x-go-name": "VolumeAttachments", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/vpc" }, "VolumeAttachmentRequest": { "description": "VolumeAttachmentRequest is the payload sent by clients when creating a volume attachmnet", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "volume": { "$ref": "#/components/schemas/Volume" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2/vpc" }, "VolumesList": { "type": "object", "title": "VolumesList ...", "properties": { "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/Volume" }, "x-go-name": "Volumes", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-storage-model/json/v2" }, "Worker": { "description": "Worker properties", "type": "object", "properties": { "errorMessage": { "type": "string", "x-go-name": "ErrorMessage", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "errorMessageDate": { "type": "string", "x-go-name": "ErrorMessageDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "type": "string", "x-go-name": "WorkerVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "machineType": { "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterVersionEOS": { "type": "string", "x-go-name": "MasterEOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "pendingOperation": { "type": "string", "x-go-name": "PendingOperation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolid": { "type": "string", "x-go-name": "PoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateIP": { "type": "string", "x-go-name": "PrivateIP", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVlan": { "type": "string", "x-go-name": "PrivateVlan", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicIP": { "type": "string", "x-go-name": "PublicIP", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVlan", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reasonForDelete": { "type": "string", "x-go-name": "ReasonForDelete", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "statusDate": { "type": "string", "x-go-name": "StatusDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "statusDetails": { "type": "string", "x-go-name": "StatusDetails", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedStatus": { "type": "string", "x-go-name": "TrustedStatus", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerCommon": { "type": "object", "title": "WorkerCommon properties common to all worker retrieval operations.", "properties": { "dedicatedHostId": { "type": "string", "x-go-name": "DedicatedHostID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "health": { "$ref": "#/components/schemas/GetWorkerResponseHealth" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kubeVersion": { "allOf": [ { "$ref": "#/components/schemas/GetWorkerResponseKubeVersion" }, { "type": "string", "x-go-name": "WorkerVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } ] }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerResponseLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolID": { "type": "string", "x-go-name": "PoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "WorkerConfig": { "description": "WorkerConfig config needed to add a worker", "type": "object", "properties": { "dataCenter": { "description": "The data center where the worker node is created.", "type": "string", "x-go-name": "DataCenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "machineType": { "description": "The machine type of the worker node.", "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "prefix": { "type": "string", "x-go-name": "Prefix", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVlan": { "description": "The private VLAN ID that the worker node is attached to.", "type": "string", "x-go-name": "PrivateVlan", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "description": "The public VLAN ID that the worker node is attached to.", "type": "string", "x-go-name": "PublicVlan", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerNum": { "type": "integer", "format": "int64", "x-go-name": "WorkerNum", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerConfigCommon": { "description": "WorkerConfigCommon common fields between V1 and V2 APIs", "type": "object", "properties": { "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "prefix": { "type": "string", "x-go-name": "Prefix", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerNum": { "type": "integer", "format": "int64", "x-go-name": "WorkerNum", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json" }, "WorkerPool": { "description": "WorkerPool common worker pool data", "type": "object", "properties": { "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "machineType": { "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "sizePerZone": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolCommon": { "type": "object", "title": "WorkerPoolCommon properties common to all workerpool retrieval operations.", "properties": { "autoscaleEnabled": { "type": "boolean", "x-go-name": "AutoscaleEnabled" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavorState": { "type": "string", "x-go-name": "FlavorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isBalanced": { "type": "boolean", "x-go-name": "IsBalanced" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerPoolResponseLifecycle" }, "openshiftLicense": { "type": "string", "x-go-name": "OpenShiftLicenseSource", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "taints": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Taints" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkersPerZone", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2" }, "WorkerPoolPatchRequest": { "description": "WorkerPoolPatchRequest provides attributes to patch update worker pool", "type": "object", "properties": { "allowSingleOpenShiftWorker": { "type": "boolean", "x-go-name": "AllowSingleOpenShiftWorker" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "reasonForResize": { "type": "string", "x-go-name": "ReasonForResize", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "sizePerZone": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolRequest": { "description": "WorkerPoolRequest provides worker pool data", "type": "object", "properties": { "diskEncryption": { "description": "If set to true, the secondary disk of the worker node is encrypted. If set to false, no encryption is set up.", "type": "boolean", "x-go-name": "DiskEncryption" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "machineType": { "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "sizePerZone": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerPoolZone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolResponse": { "description": "WorkerPoolResponse provides worker pool data", "type": "object", "properties": { "autoscaleEnabled": { "type": "boolean", "x-go-name": "AutoscaleEnabled" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isBalanced": { "type": "boolean", "x-go-name": "IsBalanced" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "machineType": { "type": "string", "x-go-name": "MachineType", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reasonForDelete": { "type": "string", "x-go-name": "ReasonForDelete", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "sizePerZone": { "type": "integer", "format": "int64", "x-go-name": "Size", "minimum": 0, "maximum": 2147483647 }, "state": { "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "zones": { "$ref": "#/components/schemas/WorkerPoolZoneResponses" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolResponses": { "type": "array", "title": "WorkerPoolResponses sorts WorkerPoolResponse by ID.", "items": { "$ref": "#/components/schemas/WorkerPoolResponse" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1", "minItems": 0, "maxItems": 100 }, "WorkerPoolZone": { "description": "WorkerPoolZone provides zone data", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolZoneNetwork": { "description": "WorkerPoolZoneNetwork holds network configuration for a zone", "type": "object", "properties": { "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolZonePatchRequest": { "description": "WorkerPoolZonePatchRequest updates worker pool zone data", "type": "object", "properties": { "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolZoneResponse": { "description": "WorkerPoolZoneResponse response contents for zone", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVlan": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVlan": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "WorkerPoolZoneResponses": { "type": "array", "title": "WorkerPoolZoneResponses sorts WorkerPoolZoneResponse by ID.", "items": { "$ref": "#/components/schemas/WorkerPoolZoneResponse" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1", "minItems": 0, "maxItems": 100 }, "WorkerPoolZoneV2": { "description": "WorkerPoolZone provides zone data", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "privateVLAN": { "type": "string", "x-go-name": "PrivateVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "publicVLAN": { "type": "string", "x-go-name": "PublicVLAN", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "WorkerPoolZone", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/classic" }, "WorkerSubnets": { "description": "WorkerSubnets a type that returns a sorted array of clusters", "type": "array", "items": { "$ref": "#/components/schemas/GenericWorkerSubnet" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v2", "minItems": 0, "maxItems": 100 }, "WorkerVolumeEncryption": { "description": "WorkerVolumeEncryption contains encryption related fields", "type": "object", "properties": { "kmsAccountID": { "type": "string", "x-go-name": "KMSAccountID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "kmsInstanceID": { "type": "string", "x-go-name": "KMSInstanceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerVolumeCRKID": { "type": "string", "x-go-name": "WorkerVolumeCRKID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "Workerpool": { "description": "Workerpool shared workerpool definition", "type": "object", "properties": { "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPool": { "type": "string", "x-go-name": "HostPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/Zone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "Zone": { "description": "Zone describes a worker pool zone", "type": "object", "properties": { "autobalanceEnabled": { "type": "boolean", "x-go-name": "AutobalanceEnabled" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "ZoneResponse": { "description": "ZoneResponse response definition for retrieving a zone", "type": "object", "properties": { "flavors": { "type": "array", "items": { "$ref": "#/components/schemas/FlavorResponse" }, "x-go-name": "Flavors", "minItems": 0, "maxItems": 100 }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "metro": { "type": "string", "x-go-name": "Metro", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc" }, "ZoneV1": { "description": "Zone properties", "type": "object", "properties": { "flavors": { "$ref": "#/components/schemas/MachineTypes" }, "id": { "description": "The ID of the zone.", "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "metro": { "type": "string", "x-go-name": "Metro", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "Zone", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1" }, "Zones": { "description": "Zones sortable list of zone responses", "type": "array", "items": { "$ref": "#/components/schemas/ZoneResponse" }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/vpc", "minItems": 0, "maxItems": 100 }, "ZonesV1": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneV1" }, "x-go-name": "Zones", "x-go-package": "github.ibm.com/alchemy-containers/armada-model/model/api/json/v1", "minItems": 0, "maxItems": 100 }, "classicGetWorkerPoolResponse": { "type": "object", "properties": { "autoscaleEnabled": { "type": "boolean", "x-go-name": "AutoscaleEnabled" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavorState": { "type": "string", "x-go-name": "FlavorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isBalanced": { "type": "boolean", "x-go-name": "IsBalanced" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerPoolResponseLifecycle" }, "openshiftLicense": { "type": "string", "x-go-name": "OpenShiftLicenseSource", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reservationID": { "type": "string", "x-go-name": "ReservationID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reservationName": { "type": "string", "x-go-name": "ReservationName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "taints": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Taints" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkersPerZone", "minimum": 0, "maximum": 2147483647 }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerPoolZoneResponse" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/combined" }, "csePatchACL": { "type": "object", "title": "CSEPatchACL represents the CSE patch configuration.", "properties": { "aclList": { "description": "The ACL list to patch", "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "ACLList", "minItems": 0, "maxItems": 100 } }, "x-go-name": "_csePatchACL", "x-go-package": "github.ibm.com/alchemy-containers/armada-global-api/server/swagger" }, "multishiftClustersResponse": { "description": "MultishiftGetServiceClusters describes a multishift service clusters response", "type": "object", "properties": { "addons": { "type": "array", "items": { "$ref": "#/components/schemas/CommonClusterAddon" }, "x-go-name": "Addons", "minItems": 0, "maxItems": 100 }, "caCertRotationStatus": { "$ref": "#/components/schemas/CommonClusterCACertRotation" }, "calicoIPAutodetectionConfig": { "type": "string", "x-go-name": "CalicoIPAutodetectionConfig", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "createdDate": { "type": "string", "x-go-name": "CreatedDate", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "datacenter": { "type": "string", "x-go-name": "Datacenter", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "desiredTrustedProfileID": { "type": "string", "x-go-name": "DesiredTrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "etcdPort": { "type": "string", "x-go-name": "EtcdPort", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "features": { "$ref": "#/components/schemas/CommonClusterFeatures" }, "hosts": { "$ref": "#/components/schemas/MultishiftClusterHosts" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "imageSecurityEnabled": { "type": "boolean", "x-go-name": "ImageSecurityEnabled" }, "ingress": { "$ref": "#/components/schemas/CommonClusterIngress" }, "isPaid": { "type": "boolean", "x-go-name": "IsPaid" }, "keyManagementService": { "$ref": "#/components/schemas/CommonClusterKMS" }, "lifecycle": { "$ref": "#/components/schemas/CommonClusterLifecycle" }, "location": { "type": "string", "x-go-name": "Location", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "locationZones": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "LocationZones", "minItems": 0, "maxItems": 100 }, "masterKubeVersion": { "type": "string", "x-go-name": "MasterVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "masterURL": { "type": "string", "x-go-name": "MasterURL", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "multiAzCapable": { "type": "boolean", "x-go-name": "MultiAZCapable" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "offering": { "type": "string", "x-go-name": "Offering", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "podSubnet": { "type": "string", "x-go-name": "PodSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "ProviderID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "region": { "type": "string", "x-go-name": "Region", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroup": { "type": "string", "x-go-name": "ResourceGroupID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "resourceGroupName": { "type": "string", "x-go-name": "ResourceGroupName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secureRequested": { "type": "boolean", "x-go-name": "SecureRequested" }, "serviceEndpoints": { "$ref": "#/components/schemas/CommonClusterServiceEndpoint" }, "serviceID": { "type": "string", "x-go-name": "ServiceID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceName": { "type": "string", "x-go-name": "ServiceName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "serviceSubnet": { "type": "string", "x-go-name": "ServiceSubnet", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "state": { "description": "The lifecycle state of the cluster. Possible values include aborted, critical, delete_failed, deleted, deleting, deploy_failed, deploying, normal, pending, requested, updating, unsupported, and warning. For more information, see the docs 'http://ibm.biz/cluster-health-states'", "type": "string", "x-go-name": "State", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "status": { "type": "string", "x-go-name": "Status", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "targetVersion": { "type": "string", "x-go-name": "TargetVersion", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "trustedProfileID": { "type": "string", "x-go-name": "TrustedProfileID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "type": { "type": "string", "x-go-name": "Type", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "versionEOS": { "type": "string", "x-go-name": "EOS", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "viewable": { "type": "boolean", "x-go-name": "Viewable" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerPools": { "type": "array", "items": { "$ref": "#/components/schemas/WorkerPool" }, "x-go-name": "WorkerPools", "minItems": 0, "maxItems": 100 } }, "x-go-name": "MultishiftGetServiceClusters", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "v2ClassicCreateWorkerPoolRequest": { "type": "object", "title": "ClassicCreateWorkerPool contains all fields in all requests to create classic worker pools.", "properties": { "Zones": { "type": "array", "items": { "$ref": "#/components/schemas/ClassicCreateWorkerPoolZone" }, "minItems": 0, "maxItems": 100 }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "reservation": { "type": "string", "x-go-name": "Reservation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-name": "ClassicCreateWorkerPool", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "v2ClassicCreateWorkerPoolResponse": { "type": "object", "title": "ClassicCreateWorkerPool is the response returned when creating a worker pool.", "properties": { "workerPoolID": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" } }, "x-go-name": "ClassicCreateWorkerPool", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/responses" }, "v2SatelliteCreateWorkerPoolRequest": { "type": "object", "title": "SatelliteCreateWorkerPool contains all fields in all requests to create satellite worker pools.", "properties": { "Zones": { "type": "array", "items": { "$ref": "#/components/schemas/SatelliteCreateWorkerPoolZone" }, "minItems": 0, "maxItems": 100 }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 } }, "x-go-name": "SatelliteCreateWorkerPool", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "v2VPCCreateWorkerPoolRequest": { "type": "object", "title": "VPCCreateWorkerPool contains all fields in all requests to create VPC worker pools.", "properties": { "Zones": { "type": "array", "items": { "$ref": "#/components/schemas/VPCCreateWorkerPoolZone" }, "minItems": 0, "maxItems": 100 }, "cluster": { "type": "string", "x-go-name": "Cluster", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "diskEncryption": { "type": "boolean", "x-go-name": "DiskEncryption" }, "entitlement": { "type": "string", "x-go-name": "Entitlement", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostPool": { "type": "string", "x-go-name": "HostPool", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "name": { "type": "string", "x-go-name": "Name", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageOption": { "type": "string", "x-go-name": "SecondaryStorageOption", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "securityGroupIDs": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "SecurityGroupIDs", "minItems": 0, "maxItems": 100 }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkerCount", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" } }, "x-go-name": "VPCCreateWorkerPool", "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/requests" }, "vpcGetWorkerPoolResponse": { "type": "object", "properties": { "autoscaleEnabled": { "type": "boolean", "x-go-name": "AutoscaleEnabled" }, "dedicatedHostPoolId": { "type": "string", "x-go-name": "DedicatedHostPoolID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavor": { "type": "string", "x-go-name": "Flavor", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "flavorState": { "type": "string", "x-go-name": "FlavorState", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "hostLabels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "HostLabels" }, "id": { "type": "string", "x-go-name": "ID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "isBalanced": { "type": "boolean", "x-go-name": "IsBalanced" }, "isolation": { "type": "string", "x-go-name": "Isolation", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "labels": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Labels" }, "lifecycle": { "$ref": "#/components/schemas/GetWorkerPoolResponseLifecycle" }, "openshiftLicense": { "type": "string", "x-go-name": "OpenshiftLicense", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "operatingSystem": { "type": "string", "x-go-name": "OperatingSystem", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "poolName": { "type": "string", "x-go-name": "PoolName", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "provider": { "type": "string", "x-go-name": "Provider", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "secondaryStorageOption": { "$ref": "#/components/schemas/DiskConfigResp" }, "staticNetworkInterfaceCount": { "type": "integer", "format": "int64", "x-go-name": "StaticNetworkInterfaceCount", "minimum": 0, "maximum": 2147483647 }, "taints": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "x-go-name": "Taints" }, "vpcID": { "type": "string", "x-go-name": "VPCID", "minLength": 1, "maxLength": 256, "pattern": "^[\\s\\S]*$" }, "workerCount": { "type": "integer", "format": "int64", "x-go-name": "WorkersPerZone", "minimum": 0, "maximum": 2147483647 }, "workerVolumeEncryption": { "$ref": "#/components/schemas/WorkerVolumeEncryption" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/GetWorkerPoolResponseZone" }, "x-go-name": "Zones", "minItems": 0, "maxItems": 100 } }, "x-go-package": "github.ibm.com/alchemy-containers/armada-api-model/json/v2/combined" } } } }