{
  "opencollection": "1.0.0",
  "info": {
    "name": "Managed Database for PostgreSQL and MySQL Access Control List Clusters API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Clusters",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Clusters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "Organization ID on which to filter the returned clusters."
              },
              {
                "name": "project_id",
                "value": "",
                "type": "query",
                "description": "Project ID on which to filter the returned clusters."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "Sort order of returned clusters."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number to return for clusters, from the paginated results."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Maximum number of clusters per page."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name to filter on, only clusters containing this substring in their name will be returned."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Status to filter on, only clusters with this status will be returned."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type to filter on, only clusters with this type will be returned."
              },
              {
                "name": "private_network_id",
                "value": "",
                "type": "query",
                "description": "Private Network ID to filter on, only clusters within this Private Network will be returned."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List all existing Kubernetes clusters in a specific region."
        },
        {
          "info": {
            "name": "Create a new Cluster",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Create a new Kubernetes cluster in a Scaleway region."
        },
        {
          "info": {
            "name": "Get a Cluster",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "ID of the requested cluster."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Retrieve information about a specific Kubernetes cluster."
        },
        {
          "info": {
            "name": "Update a Cluster",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "ID of the cluster to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Update information on a specific Kubernetes cluster. You can update details such as its name, description, tags and configuration. To upgrade a cluster, you will need to use the dedicated endpoint."
        },
        {
          "info": {
            "name": "Delete a Cluster",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "ID of the cluster to delete."
              },
              {
                "name": "with_additional_resources",
                "value": "",
                "type": "query",
                "description": "Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Delete a specific Kubernetes cluster and all its associated pools and nodes, and possibly its associated Load Balancers or Block Volumes."
        },
        {
          "info": {
            "name": "List available cluster types for a cluster",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id/available-types",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Cluster ID for which the available Kubernetes types will be listed."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List the cluster types that a specific Kubernetes cluster is allowed to switch to."
        },
        {
          "info": {
            "name": "List available versions for a Cluster",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id/available-versions",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Cluster ID for which the available Kubernetes versions will be listed."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List the versions that a specific Kubernetes cluster is allowed to upgrade to. Results will include every patch version greater than the current patch, as well as one minor version ahead of the current version. Any upgrade skipping a minor version will not work."
        },
        {
          "info": {
            "name": "Download the kubeconfig for a Cluster",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id/kubeconfig",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Cluster ID for which to download the kubeconfig."
              },
              {
                "name": "redacted",
                "value": "",
                "type": "query",
                "description": "Hide the legacy token from the kubeconfig."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Download the Kubernetes cluster config file (also known as `kubeconfig`) for a specific cluster to use it with `kubectl`.\nTip: add `?dl=1` at the end of the URL to directly retrieve the base64 decoded kubeconfig. If you choose not to, the kubeconfig will be base64 encoded."
        },
        {
          "info": {
            "name": "Reset the admin token of a Cluster",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id/reset-admin-token",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Cluster ID on which the admin token will be renewed."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Reset the admin token for a specific Kubernetes cluster. This will revoke the old admin token (which will not be usable afterwards) and create a new one. Note that you will need to download the kubeconfig again to keep interacting with the cluster."
        },
        {
          "info": {
            "name": "Change the Cluster type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id/set-type",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "ID of the cluster to migrate from one type to another."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Change the type of a specific Kubernetes cluster. To see the possible values you can enter for the `type` field, [list available cluster types](#list-available-cluster-types-for-a-cluster)."
        },
        {
          "info": {
            "name": "Upgrade a Cluster",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.scaleway.com/k8s/v1/regions/:region/clusters/:cluster_id/upgrade",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "path",
                "description": "The region you want to target"
              },
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "ID of the cluster to upgrade."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Upgrade a specific Kubernetes cluster and possibly its associated pools to a specific and supported Kubernetes version."
        }
      ]
    }
  ],
  "bundled": true
}