Chapter 11. APIs | Red Hat Product Documentation

11.1. Clusters API

11.1.1. Overview

This documentation is for the cluster resource for multicluster engine for Kubernetes. Cluster resource has four possible requests: create, query, delete and update.

11.1.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.1.1.2. Tags

cluster.open-cluster-management.io : Create and manage clusters

11.1.2. Paths

11.1.2.1. Query all clusters

GET /cluster.open-cluster-management.io/v1/managedclusters

11.1.2.1.1. Description

Query your clusters for more details.

11.1.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

11.1.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.1.2.1.4. Consumes

cluster/yaml

11.1.2.1.5. Tags

cluster.open-cluster-management.io

11.1.2.2. Create a cluster

POST /cluster.open-cluster-management.io/v1/managedclusters

11.1.2.2.1. Description

Create a cluster

11.1.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body required	Parameters describing the cluster to be created.	Cluster

11.1.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.1.2.2.4. Consumes

cluster/yaml

11.1.2.2.5. Tags

cluster.open-cluster-management.io

11.1.2.2.6. Example HTTP request

11.1.2.2.6.1. Request body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}

11.1.2.3. Query a single cluster

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

11.1.2.3.1. Description

Query a single cluster for more details.

11.1.2.3.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	cluster_name required	Name of the cluster that you want to query.	string

11.1.2.3.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.1.2.3.4. Tags

cluster.open-cluster-management.io

11.1.2.4. Delete a cluster

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

11.1.2.4.1. Description

Delete a single cluster

11.1.2.4.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	cluster_name required	Name of the cluster that you want to delete.	string

11.1.2.4.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.1.2.4.4. Tags

cluster.open-cluster-management.io

11.1.3. Definitions

11.1.3.1. Cluster

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
spec required	spec

spec

Name	Schema
hubAcceptsClient required	bool
managedClusterClientConfigs optional	< managedClusterClientConfigs > array
leaseDurationSeconds optional	integer (int32)

managedClusterClientConfigs

Name	Description	Schema
URL required		string
CABundle optional	Pattern : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`	string (byte)

11.2. Clustersets API (v1alpha1)

11.2.1. Overview

This documentation is for the Clusterset resource for multicluster engine for Kubernetes. Clusterset resource has four possible requests: create, query, delete and update.

11.2.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.2.1.2. Tags

cluster.open-cluster-management.io : Create and manage Clustersets

11.2.2. Paths

11.2.2.1. Query all clustersets

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets

11.2.2.1.1. Description

Query your Clustersets for more details.

11.2.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

11.2.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.2.2.1.4. Consumes

clusterset/yaml

11.2.2.1.5. Tags

cluster.open-cluster-management.io

11.2.2.2. Create a clusterset

POST /cluster.open-cluster-management.io/v1beta1/managedclustersets

11.2.2.2.1. Description

Create a Clusterset.

11.2.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body required	Parameters describing the clusterset to be created.	Clusterset

11.2.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.2.2.2.4. Consumes

clusterset/yaml

11.2.2.2.5. Tags

cluster.open-cluster-management.io

11.2.2.2.6. Example HTTP request

11.2.2.2.6.1. Request body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "clusterset1"
  },
  "spec": { },
  "status" : { }
}

11.2.2.3. Query a single clusterset

GET /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}

11.2.2.3.1. Description

Query a single clusterset for more details.

11.2.2.3.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterset_name required	Name of the clusterset that you want to query.	string

11.2.2.3.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.2.2.3.4. Tags

cluster.open-cluster-management.io

11.2.2.4. Delete a clusterset

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}

11.2.2.4.1. Description

Delete a single clusterset.

11.2.2.4.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterset_name required	Name of the clusterset that you want to delete.	string

11.2.2.4.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.2.2.4.4. Tags

cluster.open-cluster-management.io

11.2.3. Definitions

11.2.3.1. Clusterset

Name	Schema
apiVersion required	string
kind required	string
metadata required	object

11.3. Clusterview API (v1alpha1)

11.3.1. Overview

This documentation is for the clusterview resource for multicluster engine for Kubernetes. The clusterview resource provides a CLI command that enables you to view a list of the managed clusters and managed cluster sets that that you can access. The three possible requests are: list, get, and watch.

11.3.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.3.1.2. Tags

clusterview.open-cluster-management.io : View a list of managed clusters that your ID can access.

11.3.2. Paths

11.3.2.1. Get managed clusters

GET /managedclusters.clusterview.open-cluster-management.io

11.3.2.1.1. Description

View a list of the managed clusters that you can access.

11.3.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

11.3.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.3.2.1.4. Consumes

managedcluster/yaml

11.3.2.1.5. Tags

clusterview.open-cluster-management.io

11.3.2.2. List managed clusters

LIST /managedclusters.clusterview.open-cluster-management.io

11.3.2.2.1. Description

View a list of the managed clusters that you can access.

11.3.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body optional	Name of the user ID for which you want to list the managed clusters.	string

11.3.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.3.2.2.4. Consumes

managedcluster/yaml

11.3.2.2.5. Tags

clusterview.open-cluster-management.io

11.3.2.2.6. Example HTTP request

11.3.2.2.6.1. Request body

{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}

11.3.2.3. Watch the managed cluster sets

WATCH /managedclusters.clusterview.open-cluster-management.io

11.3.2.3.1. Description

Watch the managed clusters that you can access.

11.3.2.3.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

11.3.2.3.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.3.2.4. List the managed cluster sets.

GET /managedclustersets.clusterview.open-cluster-management.io

11.3.2.4.1. Description

List the managed clusters that you can access.

11.3.2.4.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

11.3.2.4.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.3.2.5. List the managed cluster sets.

LIST /managedclustersets.clusterview.open-cluster-management.io

11.3.2.5.1. Description

List the managed clusters that you can access.

11.3.2.5.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

11.3.2.5.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.3.2.6. Watch the managed cluster sets.

WATCH /managedclustersets.clusterview.open-cluster-management.io

11.3.2.6.1. Description

Watch the managed clusters that you can access.

11.3.2.6.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	clusterview_name optional	Name of the user ID that you want to watch.	string

11.3.2.6.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.4. Clustersetbindings API (v1alpha1)

11.4.1. Overview

This documentation is for the clustersetbinding resource for multicluster engine for Kubernetes. Clustersetbinding resource has four possible requests: create, query, delete and update.

11.4.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.4.1.2. Tags

cluster.open-cluster-management.io : Create and manage clustersetbindings

11.4.2. Paths

11.4.2.1. Query all clustersetbindings

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings

11.4.2.1.1. Description

Query your clustersetbindings for more details.

11.4.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

11.4.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.4.2.1.4. Consumes

clustersetbinding/yaml

11.4.2.1.5. Tags

cluster.open-cluster-management.io

11.4.2.2. Create a clustersetbinding

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings

11.4.2.2.1. Description

Create a clustersetbinding.

11.4.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the clustersetbinding to be created.	Clustersetbinding

11.4.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.4.2.2.4. Consumes

clustersetbinding/yaml

11.4.2.2.5. Tags

cluster.open-cluster-management.io

11.4.2.2.6. Example HTTP request

11.4.2.2.6.1. Request body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

11.4.2.3. Query a single clustersetbinding

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}

11.4.2.3.1. Description

Query a single clustersetbinding for more details.

11.4.2.3.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	clustersetbinding_name required	Name of the clustersetbinding that you want to query.	string

11.4.2.3.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.4.2.3.4. Tags

cluster.open-cluster-management.io

11.4.2.4. Delete a clustersetbinding

DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersetbindings/{clustersetbinding_name}

11.4.2.4.1. Description

Delete a single clustersetbinding.

11.4.2.4.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	clustersetbinding_name required	Name of the clustersetbinding that you want to delete.	string

11.4.2.4.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.4.2.4.4. Tags

cluster.open-cluster-management.io

11.4.3. Definitions

11.4.3.1. Clustersetbinding

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
spec required	spec

spec

Name	Schema
clusterSet required	string

11.5. API

11.5.1. Overview

This documentation is for the MultiClusterEngine resource for multicluster engine for Kubernetes. The MultiClusterEngine resource has four possible requests: create, query, delete, and update.

11.5.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.5.1.2. Tags

multiclusterengines.multicluster.openshift.io : Create and manage MultiClusterEngines

11.5.2. Paths

11.5.2.1. Create a MultiClusterEngine

POST /apis/multicluster.openshift.io/v1alpha1/multiclusterengines

11.5.2.1.1. Description

Create a MultiClusterEngine.

11.5.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body required	Parameters describing the MultiClusterEngine to be created.	MultiClusterEngine

11.5.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.5.2.1.4. Consumes

MultiClusterEngines/yaml

11.5.2.1.5. Tags

multiclusterengines.multicluster.openshift.io

11.5.2.1.5.1. Request body

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1"
    },
    "creationTimestamp": null,
    "name": "multiclusterengines.multicluster.openshift.io"
  },
  "spec": {
    "group": "multicluster.openshift.io",
    "names": {
      "kind": "MultiClusterEngine",
      "listKind": "MultiClusterEngineList",
      "plural": "multiclusterengines",
      "shortNames": [
        "mce"
      ],
      "singular": "multiclusterengine"
    },
    "scope": "Cluster",
    "versions": [
      {
        "additionalPrinterColumns": [
          {
            "description": "The overall state of the MultiClusterEngine",
            "jsonPath": ".status.phase",
            "name": "Status",
            "type": "string"
          },
          {
            "jsonPath": ".metadata.creationTimestamp",
            "name": "Age",
            "type": "date"
          }
        ],
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "MultiClusterEngine is the Schema for the multiclusterengines\nAPI",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation\nof an object. Servers should convert recognized schemas to the latest\ninternal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "Kind is a string value representing the REST resource this\nobject represents. Servers may infer this from the endpoint the client\nsubmits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "MultiClusterEngineSpec defines the desired state of MultiClusterEngine",
                "properties": {
                  "imagePullSecret": {
                    "description": "Override pull secret for accessing MultiClusterEngine\noperand and endpoint images",
                    "type": "string"
                  },
                  "nodeSelector": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set the nodeselectors",
                    "type": "object"
                  },
                  "targetNamespace": {
                    "description": "Location where MCE resources will be placed",
                    "type": "string"
                  },
                  "tolerations": {
                    "description": "Tolerations causes all components to tolerate any taints.",
                    "items": {
                      "description": "The pod this Toleration is attached to tolerates any\ntaint that matches the triple <key,value,effect> using the matching\noperator <operator>.",
                      "properties": {
                        "effect": {
                          "description": "Effect indicates the taint effect to match. Empty\nmeans match all taint effects. When specified, allowed values\nare NoSchedule, PreferNoSchedule and NoExecute.",
                          "type": "string"
                        },
                        "key": {
                          "description": "Key is the taint key that the toleration applies\nto. Empty means match all taint keys. If the key is empty,\noperator must be Exists; this combination means to match all\nvalues and all keys.",
                          "type": "string"
                        },
                        "operator": {
                          "description": "Operator represents a key's relationship to the\nvalue. Valid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod\ncan tolerate all taints of a particular category.",
                          "type": "string"
                        },
                        "tolerationSeconds": {
                          "description": "TolerationSeconds represents the period of time\nthe toleration (which must be of effect NoExecute, otherwise\nthis field is ignored) tolerates the taint. By default, it\nis not set, which means tolerate the taint forever (do not\nevict). Zero and negative values will be treated as 0 (evict\nimmediately) by the system.",
                          "format": "int64",
                          "type": "integer"
                        },
                        "value": {
                          "description": "Value is the taint value the toleration matches\nto. If the operator is Exists, the value should be empty,\notherwise just a regular string.",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "status": {
                "description": "MultiClusterEngineStatus defines the observed state of MultiClusterEngine",
                "properties": {
                  "components": {
                    "items": {
                      "description": "ComponentCondition contains condition information for\ntracked components",
                      "properties": {
                        "kind": {
                          "description": "The resource kind this condition represents",
                          "type": "string"
                        },
                        "lastTransitionTime": {
                          "description": "LastTransitionTime is the last time the condition\nchanged from one status to another.",
                          "format": "date-time",
                          "type": "string"
                        },
                        "message": {
                          "description": "Message is a human-readable message indicating\ndetails about the last status change.",
                          "type": "string"
                        },
                        "name": {
                          "description": "The component name",
                          "type": "string"
                        },
                        "reason": {
                          "description": "Reason is a (brief) reason for the condition's\nlast status change.",
                          "type": "string"
                        },
                        "status": {
                          "description": "Status is the status of the condition. One of True,\nFalse, Unknown.",
                          "type": "string"
                        },
                        "type": {
                          "description": "Type is the type of the cluster condition.",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "conditions": {
                    "items": {
                      "properties": {
                        "lastTransitionTime": {
                          "description": "LastTransitionTime is the last time the condition\nchanged from one status to another.",
                          "format": "date-time",
                          "type": "string"
                        },
                        "lastUpdateTime": {
                          "description": "The last time this condition was updated.",
                          "format": "date-time",
                          "type": "string"
                        },
                        "message": {
                          "description": "Message is a human-readable message indicating\ndetails about the last status change.",
                          "type": "string"
                        },
                        "reason": {
                          "description": "Reason is a (brief) reason for the condition's\nlast status change.",
                          "type": "string"
                        },
                        "status": {
                          "description": "Status is the status of the condition. One of True,\nFalse, Unknown.",
                          "type": "string"
                        },
                        "type": {
                          "description": "Type is the type of the cluster condition.",
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "phase": {
                    "description": "Latest observed overall state",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

11.5.2.2. Query all MultiClusterEngines

GET /apis/multicluster.openshift.io/v1alpha1/multiclusterengines

11.5.2.2.1. Description

Query your multicluster engine for more details.

11.5.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

11.5.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.5.2.2.4. Consumes

operator/yaml

11.5.2.2.5. Tags

multiclusterengines.multicluster.openshift.io

11.5.2.3. Delete a MultiClusterEngine operator

DELETE /apis/multicluster.openshift.io/v1alpha1/multiclusterengines/{name}

11.5.2.3.1. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	name required	Name of the multiclusterengine that you want to delete.	string

11.5.2.3.2. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.5.2.3.3. Tags

multiclusterengines.multicluster.openshift.io

11.5.3. Definitions

11.5.3.1. MultiClusterEngine

Name	Description	Schema
apiVersion required	The versioned schema of the MultiClusterEngines.	string
kind required	String value that represents the REST resource.	string
metadata required	Describes rules that define the resource.	object
spec required	MultiClusterEngineSpec defines the desired state of MultiClusterEngine.	See List of specs

11.5.3.2. List of specs

Name	Description	Schema
nodeSelector optional	Set the nodeselectors.	map[string]string
imagePullSecret optional	Override pull secret for accessing MultiClusterEngine operand and endpoint images.	string
tolerations optional	Tolerations causes all components to tolerate any taints.	[]corev1.Toleration
targetNamespace optional	Location where MCE resources will be placed.	string

11.6. Placements API (v1alpha1)

11.6.1. Overview

This documentation is for the Placement resource for multicluster engine for Kubernetes. Placement resource has four possible requests: create, query, delete and update.

11.6.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.6.1.2. Tags

cluster.open-cluster-management.io : Create and manage Placements

11.6.2. Paths

11.6.2.1. Query all Placements

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements

11.6.2.1.1. Description

Query your Placements for more details.

11.6.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

11.6.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.6.2.1.4. Consumes

placement/yaml

11.6.2.1.5. Tags

cluster.open-cluster-management.io

11.6.2.2. Create a Placement

POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements

11.6.2.2.1. Description

Create a Placement.

11.6.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body required	Parameters describing the placement to be created.	Placement

11.6.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.6.2.2.4. Consumes

placement/yaml

11.6.2.2.5. Tags

cluster.open-cluster-management.io

11.6.2.2.6. Example HTTP request

11.6.2.2.6.1. Request body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "Placement",
  "metadata" : {
    "name" : "placement1",
    "namespace": "ns1"
  },
  "spec": {
    "predicates": [
      {
        "requiredClusterSelector": {
          "labelSelector": {
            "matchLabels": {
              "vendor": "OpenShift"
            }
          }
        }
      }
    ]
  },
  "status" : { }
}

11.6.2.3. Query a single Placement

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}

11.6.2.3.1. Description

Query a single Placement for more details.

11.6.2.3.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placement_name required	Name of the Placement that you want to query.	string

11.6.2.3.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.6.2.3.4. Tags

cluster.open-cluster-management.io

11.6.2.4. Delete a Placement

DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placements/{placement_name}

11.6.2.4.1. Description

Delete a single Placement.

11.6.2.4.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placement_name required	Name of the Placement that you want to delete.	string

11.6.2.4.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.6.2.4.4. Tags

cluster.open-cluster-management.io

11.6.3. Definitions

11.6.3.1. Placement

Name	Description	Schema
apiVersion required	The versioned schema of the Placement.	string
kind required	String value that represents the REST resource.	string
metadata required	The meta data of the Placement.	object
spec required	The specification of the Placement.	spec

spec

Name	Description	Schema
ClusterSets optional	A subset of ManagedClusterSets from which the ManagedClusters are selected. If it is empty, ManagedClusters is selected from the ManagedClusterSets that are bound to the Placement namespace. Otherwise, ManagedClusters are selected from the intersection of this subset and the ManagedClusterSets are bound to the placement namespace.	string array
numberOfClusters optional	The desired number of ManagedClusters to be selected.	integer (int32)
predicates optional	A subset of cluster predicates to select ManagedClusters. The conditional logic is OR.	clusterPredicate array

clusterPredicate

Name	Description	Schema
requiredClusterSelector optional	A cluster selector to select ManagedClusters with a label and cluster claim.	clusterSelector

clusterSelector

Name	Description	Schema
labelSelector optional	A selector of ManagedClusters by label.	object
claimSelector optional	A selector of ManagedClusters by claim.	clusterClaimSelector

clusterClaimSelector

Name	Description	Schema
matchExpressions optional	A subset of the cluster claim selector requirements. The conditional logic is AND.	< object > array

11.7. PlacementDecisions API (v1alpha1)

11.7.1. Overview

This documentation is for the PlacementDecision resource for multicluster engine for Kubernetes. PlacementDecision resource has four possible requests: create, query, delete and update.

11.7.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.7.1.2. Tags

cluster.open-cluster-management.io : Create and manage PlacementDecisions.

11.7.2. Paths

11.7.2.1. Query all PlacementDecisions

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions

11.7.2.1.1. Description

Query your PlacementDecisions for more details.

11.7.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string

11.7.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.7.2.1.4. Consumes

placementdecision/yaml

11.7.2.1.5. Tags

cluster.open-cluster-management.io

11.7.2.2. Create a PlacementDecision

POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions

11.7.2.2.1. Description

Create a PlacementDecision.

11.7.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body required	Parameters describing the PlacementDecision to be created.	PlacementDecision

11.7.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.7.2.2.4. Consumes

placementdecision/yaml

11.7.2.2.5. Tags

cluster.open-cluster-management.io

11.7.2.2.6. Example HTTP request

11.7.2.2.6.1. Request body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "PlacementDecision",
  "metadata" : {
    "labels" : {
      "cluster.open-cluster-management.io/placement" : "placement1"
    },
    "name" : "placement1-decision1",
    "namespace": "ns1"
  },
  "status" : { }
}

11.7.2.3. Query a single PlacementDecision

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

11.7.2.3.1. Description

Query a single PlacementDecision for more details.

11.7.2.3.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placementdecision_name required	Name of the PlacementDecision that you want to query.	string

11.7.2.3.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.7.2.3.4. Tags

cluster.open-cluster-management.io

11.7.2.4. Delete a PlacementDecision

DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

11.7.2.4.1. Description

Delete a single PlacementDecision.

11.7.2.4.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	placementdecision_name required	Name of the PlacementDecision that you want to delete.	string

11.7.2.4.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.7.2.4.4. Tags

cluster.open-cluster-management.io

11.7.3. Definitions

11.7.3.1. PlacementDecision

Name	Description	Schema
apiVersion required	The versioned schema of PlacementDecision.	string
kind required	String value that represents the REST resource.	string
metadata required	The meta data of PlacementDecision.	object

11.8. Managed service account (Technology Preview)

11.8.1. Overview

This documentation is for the ManagedServiceAccount resource for the multicluster engine for Kubernetes operator. The ManagedServiceAccount resource has four possible requests: create, query, delete, and update.

11.8.1.1. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

11.8.1.2. Tags

managedserviceaccounts.multicluster.openshift.io`: Create and manage ManagedServiceAccounts

11.8.2. Paths

11.8.2.1. Create a ManagedServiceAccount

POST /apis/multicluster.openshift.io/v1alpha1/ManagedServiceAccounts

11.8.2.1.1. Description

Create a ManagedServiceAccount.

11.8.2.1.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Body	body required	Parameters describing the ManagedServiceAccount to be created.	ManagedServiceAccount

11.8.2.1.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.8.2.1.4. Consumes

managedserviceaccount/yaml

11.8.2.1.5. Tags

managedserviceaccount.multicluster.openshift.io

11.8.2.1.5.1. Request body

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1"
    },
    "creationTimestamp": null,
    "name": "managedserviceaccount.authentication.open-cluster-management.io"
  },
  "spec": {
    "group": "authentication.open-cluster-management.io",
    "names": {
      "kind": "ManagedServiceAccount",
      "listKind": "ManagedServiceAccountList",
      "plural": "managedserviceaccounts",
      "singular": "managedserviceaccount"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "ManagedServiceAccount is the Schema for the managedserviceaccounts\nAPI",
            "properties": {
              "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation\nof an object. Servers should convert recognized schemas to the latest\ninternal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
              },
              "kind": {
                "description": "Kind is a string value representing the REST resource this\nobject represents. Servers may infer this from the endpoint the client\nsubmits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
              },
              "metadata": {
                "type": "object"
              },
              "spec": {
                "description": "ManagedServiceAccountSpec defines the desired state of ManagedServiceAccount",
                "properties": {
                  "rotation": {
                    "description": "Rotation is the policy for rotation the credentials.",
                    "properties": {
                      "enabled": {
                        "default": true,
                        "description": "Enabled prescribes whether the ServiceAccount token\nwill be rotated from the upstream",
                        "type": "boolean"
                      },
                      "validity": {
                        "default": "8640h0m0s",
                        "description": "Validity is the duration for which the signed ServiceAccount\ntoken is valid.",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "ttlSecondsAfterCreation": {
                    "description": "ttlSecondsAfterCreation limits the lifetime of a ManagedServiceAccount.\nIf the ttlSecondsAfterCreation field is set, the ManagedServiceAccount\nwill be automatically deleted regardless of the ManagedServiceAccount's\nstatus. When the ManagedServiceAccount is deleted, its lifecycle\nguarantees (e.g. finalizers) will be honored. If this field is unset,\nthe ManagedServiceAccount won't be automatically deleted. If this\nfield is set to zero, the ManagedServiceAccount becomes eligible\nfor deletion immediately after its creation. In order to use ttlSecondsAfterCreation,\nthe EphemeralIdentity feature gate must be enabled.",
                    "exclusiveMinimum": true,
                    "format": "int32",
                    "minimum": 0,
                    "type": "integer"
                  }
                },
                "required": [
                  "rotation"
                ],
                "type": "object"
              },
              "status": {
                "description": "ManagedServiceAccountStatus defines the observed state of\nManagedServiceAccount",
                "properties": {
                  "conditions": {
                    "description": "Conditions is the condition list.",
                    "items": {
                      "description": "Condition contains details for one aspect of the current\nstate of this API Resource. --- This struct is intended for direct\nuse as an array at the field path .status.conditions.  For example,\ntype FooStatus struct{     // Represents the observations of a\nfoo's current state.     // Known .status.conditions.type are:\n\"Available\", \"Progressing\", and \"Degraded\"     // +patchMergeKey=type\n    // +patchStrategy=merge     // +listType=map     // +listMapKey=type\n    Conditions []metav1.Condition `json:\"conditions,omitempty\"\npatchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n     // other fields }",
                      "properties": {
                        "lastTransitionTime": {
                          "description": "lastTransitionTime is the last time the condition\ntransitioned from one status to another. This should be when\nthe underlying condition changed.  If that is not known, then\nusing the time when the API field changed is acceptable.",
                          "format": "date-time",
                          "type": "string"
                        },
                        "message": {
                          "description": "message is a human readable message indicating\ndetails about the transition. This may be an empty string.",
                          "maxLength": 32768,
                          "type": "string"
                        },
                        "observedGeneration": {
                          "description": "observedGeneration represents the .metadata.generation\nthat the condition was set based upon. For instance, if .metadata.generation\nis currently 12, but the .status.conditions[x].observedGeneration\nis 9, the condition is out of date with respect to the current\nstate of the instance.",
                          "format": "int64",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "reason": {
                          "description": "reason contains a programmatic identifier indicating\nthe reason for the condition's last transition. Producers\nof specific condition types may define expected values and\nmeanings for this field, and whether the values are considered\na guaranteed API. The value should be a CamelCase string.\nThis field may not be empty.",
                          "maxLength": 1024,
                          "minLength": 1,
                          "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
                          "type": "string"
                        },
                        "status": {
                          "description": "status of the condition, one of True, False, Unknown.",
                          "enum": [
                            "True",
                            "False",
                            "Unknown"
                          ],
                          "type": "string"
                        },
                        "type": {
                          "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n--- Many .condition.type values are consistent across resources\nlike Available, but because arbitrary conditions can be useful\n(see .node.status.conditions), the ability to deconflict is\nimportant. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
                          "maxLength": 316,
                          "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
                          "type": "string"
                        }
                      },
                      "required": [
                        "lastTransitionTime",
                        "message",
                        "reason",
                        "status",
                        "type"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "expirationTimestamp": {
                    "description": "ExpirationTimestamp is the time when the token will expire.",
                    "format": "date-time",
                    "type": "string"
                  },
                  "tokenSecretRef": {
                    "description": "TokenSecretRef is a reference to the corresponding ServiceAccount's\nSecret, which stores the CA certficate and token from the managed\ncluster.",
                    "properties": {
                      "lastRefreshTimestamp": {
                        "description": "LastRefreshTimestamp is the timestamp indicating\nwhen the token in the Secret is refreshed.",
                        "format": "date-time",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name is the name of the referenced secret.",
                        "type": "string"
                      }
                    },
                    "required": [
                      "lastRefreshTimestamp",
                      "name"
                    ],
                    "type": "object"
                  }
                },
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

11.8.2.2. Query a single ManagedServiceAccount

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedserviceaccounts/{managedserviceaccount_name}

11.8.2.2.1. Description

Query a single ManagedServiceAccount for more details.

11.8.2.2.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	managedserviceaccount_name required	Name of the `ManagedServiceAccount` that you want to query.	string

11.8.2.2.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.8.2.2.4. Tags

cluster.open-cluster-management.io

11.8.2.3. Delete a `ManagedServiceAccount`

DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedserviceaccounts/{managedserviceaccount_name}

11.8.2.3.1. Description

Delete a single ManagedServiceAccount.

11.8.2.3.2. Parameters

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	managedserviceaccount_name required	Name of the `ManagedServiceAccount` that you want to delete.	string

11.8.2.3.3. Responses

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

11.8.2.3.4. Tags

cluster.open-cluster-management.io

11.8.3. Definitions

11.8.3.1. `ManagedServiceAccount`

Name	Description	Schema
apiVersion required	The versioned schema of the `ManagedServiceAccount`.	string
kind required	String value that represents the REST resource.	string
metadata required	The meta data of the `ManagedServiceAccount`.	object
spec required	The specification of the `ManagedServiceAccount`.