# readAppsV1NamespacedStatefulSet

From **Kubernetes**.

`GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}`

read the specified StatefulSet

## Parameters

### `name`

- Location: path
- Required: true
- Type: `string`
- uniqueItems: `true`

name of the StatefulSet

### `namespace`

- Location: path
- Required: true
- Type: `string`
- uniqueItems: `true`

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

### `pretty`

- Location: query
- Required: false
- Type: `string`
- uniqueItems: `true`

If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

## Responses

### `200`

OK

### `application/cbor`

- Type: `object`

StatefulSet represents a set of pods with consistent identities. Identities are defined as:
  - Network: A single stable DNS and hostname.
  - Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

```json
{"description":"StatefulSet represents a set of pods with consistent identities. Identities are defined as:\n  - Network: A single stable DNS and hostname.\n  - Storage: As many VolumeClaims as requested.\n\nThe StatefulSet guarantees that a given network identity will always map to the same storage identity.","properties":{"apiVersion":{"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal 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 object represents. Servers may infer this from the endpoint the client submits 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":{"allOf":[{"$ref":"#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"}],"default":{},"description":"Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"},"spec":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetSpec"}],"default":{},"description":"Spec defines the desired identities of pods in this set."},"status":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetStatus"}],"default":{},"description":"Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time."}},"required":["spec"],"type":"object","x-kubernetes-group-version-kind":[{"group":"apps","kind":"StatefulSet","version":"v1"}]}
```

### `application/json`

- Type: `object`

StatefulSet represents a set of pods with consistent identities. Identities are defined as:
  - Network: A single stable DNS and hostname.
  - Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

```json
{"description":"StatefulSet represents a set of pods with consistent identities. Identities are defined as:\n  - Network: A single stable DNS and hostname.\n  - Storage: As many VolumeClaims as requested.\n\nThe StatefulSet guarantees that a given network identity will always map to the same storage identity.","properties":{"apiVersion":{"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal 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 object represents. Servers may infer this from the endpoint the client submits 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":{"allOf":[{"$ref":"#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"}],"default":{},"description":"Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"},"spec":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetSpec"}],"default":{},"description":"Spec defines the desired identities of pods in this set."},"status":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetStatus"}],"default":{},"description":"Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time."}},"required":["spec"],"type":"object","x-kubernetes-group-version-kind":[{"group":"apps","kind":"StatefulSet","version":"v1"}]}
```

### `application/vnd.kubernetes.protobuf`

- Type: `object`

StatefulSet represents a set of pods with consistent identities. Identities are defined as:
  - Network: A single stable DNS and hostname.
  - Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

```json
{"description":"StatefulSet represents a set of pods with consistent identities. Identities are defined as:\n  - Network: A single stable DNS and hostname.\n  - Storage: As many VolumeClaims as requested.\n\nThe StatefulSet guarantees that a given network identity will always map to the same storage identity.","properties":{"apiVersion":{"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal 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 object represents. Servers may infer this from the endpoint the client submits 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":{"allOf":[{"$ref":"#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"}],"default":{},"description":"Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"},"spec":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetSpec"}],"default":{},"description":"Spec defines the desired identities of pods in this set."},"status":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetStatus"}],"default":{},"description":"Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time."}},"required":["spec"],"type":"object","x-kubernetes-group-version-kind":[{"group":"apps","kind":"StatefulSet","version":"v1"}]}
```

### `application/yaml`

- Type: `object`

StatefulSet represents a set of pods with consistent identities. Identities are defined as:
  - Network: A single stable DNS and hostname.
  - Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

```json
{"description":"StatefulSet represents a set of pods with consistent identities. Identities are defined as:\n  - Network: A single stable DNS and hostname.\n  - Storage: As many VolumeClaims as requested.\n\nThe StatefulSet guarantees that a given network identity will always map to the same storage identity.","properties":{"apiVersion":{"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal 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 object represents. Servers may infer this from the endpoint the client submits 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":{"allOf":[{"$ref":"#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"}],"default":{},"description":"Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"},"spec":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetSpec"}],"default":{},"description":"Spec defines the desired identities of pods in this set."},"status":{"allOf":[{"$ref":"#/components/schemas/io.k8s.api.apps.v1.StatefulSetStatus"}],"default":{},"description":"Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time."}},"required":["spec"],"type":"object","x-kubernetes-group-version-kind":[{"group":"apps","kind":"StatefulSet","version":"v1"}]}
```

### `401`

Unauthorized

## Request examples

### cURL

```shell
curl --request GET \
  --url '/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}'
```
