Try Kubernetes

Reference Documentation

Design docs, concept definitions, and references for APIs and CLIs.

Documentation for Kubernetes v1.6 is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.

Edit This Page

Operations

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

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)

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

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)

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. Defaults to Default. Either this field or OrphanDependents may be set, but not both.

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

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)

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

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)

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

Analytics

Create an Issue Edit this Page