Try Kubernetes

Support

Troubleshooting resources, frequently asked questions, and community support channels.

Documentation for Kubernetes v1.5 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/apps/v1beta1

Responses

HTTP Code Description Schema

default

success

unversioned.APIResourceList

Consumes

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

list or watch objects of kind StatefulSet

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

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.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSetList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Tags

  • apisappsv1beta1

delete collection of StatefulSet

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

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.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

create a StatefulSet

POST /apis/apps/v1beta1/namespaces/{namespace}/statefulsets

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.StatefulSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

read the specified StatefulSet

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{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

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

replace the specified StatefulSet

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.StatefulSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

delete a StatefulSet

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{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

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

unversioned.Status

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

partially update the specified StatefulSet

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSet

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

read status of the specified StatefulSet

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

replace status of the specified StatefulSet

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{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.StatefulSet

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSet

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

partially update status of the specified StatefulSet

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

Parameters

Type Name Description Required Schema Default

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSet

Consumes

  • application/json-patch+json

  • application/merge-patch+json

  • application/strategic-merge-patch+json

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Tags

  • apisappsv1beta1

list or watch objects of kind StatefulSet

GET /apis/apps/v1beta1/statefulsets

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.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

Responses

HTTP Code Description Schema

200

success

v1beta1.StatefulSetList

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Tags

  • apisappsv1beta1

watch individual changes to a list of StatefulSet

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets

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.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Tags

  • apisappsv1beta1

watch changes to an object of kind StatefulSet

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets/{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.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the StatefulSet

true

string

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Tags

  • apisappsv1beta1

watch individual changes to a list of StatefulSet

GET /apis/apps/v1beta1/watch/statefulsets

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.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

Responses

HTTP Code Description Schema

200

success

versioned.Event

Consumes

  • /

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

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

Tags

  • apisappsv1beta1

Analytics

Create an Issue Edit this Page