--- title: federation/v1beta1 Operations notitle: true ---

## Operations

### get available resources

    GET /apis/federation/v1beta1

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
default | success | v1.APIResourceList

#### Consumes

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### list or watch objects of kind Cluster

    GET /apis/federation/v1beta1/clusters

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string |
QueryParameter | includeUninitialized | If true, partially initialized resources are included in the response. | false | boolean |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean |

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer (int32) |

QueryParameter

limit

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

false

integer (int32)

QueryParameter

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

false

string

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1beta1.ClusterList

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

- application/json;stream=watch

- application/vnd.kubernetes.protobuf;stream=watch

#### Tags

- apisfederationv1beta1

### delete collection of Cluster

    DELETE /apis/federation/v1beta1/clusters

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string |
QueryParameter | includeUninitialized | If true, partially initialized resources are included in the response. | false | boolean |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean |

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer (int32) |

QueryParameter

limit

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

false

integer (int32)

QueryParameter

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

false

string

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1.Status

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### create a Cluster

    POST /apis/federation/v1beta1/clusters

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
BodyParameter | body |  | true | v1beta1.Cluster |

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1beta1.Cluster

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### read the specified Cluster

    GET /apis/federation/v1beta1/clusters/{name}

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
QueryParameter | export | Should this value be exported. Export strips fields that a user can not specify. | false | boolean |
QueryParameter | exact | Should the export be exact. Exact export maintains cluster-specific fields like Namespace. | false | boolean |
PathParameter | name | name of the Cluster | true | string |

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1beta1.Cluster

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### replace the specified Cluster

    PUT /apis/federation/v1beta1/clusters/{name}

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
BodyParameter | body |  | true | v1beta1.Cluster |
PathParameter | name | name of the Cluster | true | string |

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1beta1.Cluster

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### delete a Cluster

    DELETE /apis/federation/v1beta1/clusters/{name}

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
BodyParameter | body |  | true | v1.DeleteOptions |
QueryParameter | gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | false | integer (int32) |
QueryParameter | orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. | false | boolean |
QueryParameter | propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | false | string |
PathParameter | name | name of the Cluster | true | string |

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1.Status

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### partially update the specified Cluster

    PATCH /apis/federation/v1beta1/clusters/{name}

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
BodyParameter | body |  | true | v1.Patch |
PathParameter | name | name of the Cluster | true | string |

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1beta1.Cluster

#### Consumes

- application/json-patch+json

- application/merge-patch+json

- application/strategic-merge-patch+json

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### replace status of the specified Cluster

    PUT /apis/federation/v1beta1/clusters/{name}/status

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
BodyParameter | body |  | true | v1beta1.Cluster |
PathParameter | name | name of the Cluster | true | string |

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1beta1.Cluster

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

#### Tags

- apisfederationv1beta1

### watch individual changes to a list of Cluster

    GET /apis/federation/v1beta1/watch/clusters

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string |
QueryParameter | includeUninitialized | If true, partially initialized resources are included in the response. | false | boolean |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean |

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer (int32) |

QueryParameter

limit

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

false

integer (int32)

QueryParameter

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

false

string

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1.WatchEvent

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

- application/json;stream=watch

- application/vnd.kubernetes.protobuf;stream=watch

#### Tags

- apisfederationv1beta1

### watch changes to an object of kind Cluster

    GET /apis/federation/v1beta1/watch/clusters/{name}

#### Parameters

Type | Name | Description | Required | Schema | Default
--- | --- | --- | --- | --- | ---
QueryParameter | pretty | If true, then the output is pretty printed. | false | string |
QueryParameter | labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. | false | string |
QueryParameter | fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. | false | string |
QueryParameter | includeUninitialized | If true, partially initialized resources are included in the response. | false | boolean |
QueryParameter | watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | false | boolean |

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

false

string

QueryParameter | timeoutSeconds | Timeout for the list/watch call. | false | integer (int32) |

QueryParameter

limit

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

false

integer (int32)

QueryParameter

continue

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

false

string

PathParameter | name | name of the Cluster | true | string |

#### Responses

HTTP Code | Description | Schema
--- | --- | ---
200 | success | v1.WatchEvent

#### Consumes

- /

#### Produces

- application/json

- application/yaml

- application/vnd.kubernetes.protobuf

- application/json;stream=watch

- application/vnd.kubernetes.protobuf;stream=watch

#### Tags

- apisfederationv1beta1