whentimeslows/website

Fork 0

Files

T

gregoplex 4fb669be11 Fixed doc typo

2017-01-17 20:35:24 -05:00

41 KiB

Raw Blame History

Pod v1

bdocs-tab:kubectl Pod Config to print "Hello World".


apiVersion: v1
kind: Pod
metadata:
  name: pod-example
spec:
  containers:
  - image: ubuntu:trusty
    command: ["echo"]
    args: ["Hello World"]

bdocs-tab:curl Pod Config to print "Hello World".


apiVersion: v1
kind: Pod
metadata:
  name: pod-example
spec:
  containers:
  - image: ubuntu:trusty
    command: ["echo"]
    args: ["Hello World"]

Group	Version	Kind
Core	v1	Pod

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

Field	Description
apiVersion string	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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
kind string	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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
spec PodSpec	Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
status PodStatus	Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

PodSpec v1

Field	Description
activeDeadlineSeconds integer	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
containers Container array	List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers
dnsPolicy string	Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst".
hostIPC boolean	Use the host's ipc namespace. Optional: Default to false.
hostNetwork boolean	Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
hostPID boolean	Use the host's pid namespace. Optional: Default to false.
hostname string	Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
imagePullSecrets LocalObjectReference array	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
nodeName string	NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
nodeSelector object	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection/README
restartPolicy string	Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy
securityContext PodSecurityContext	SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
serviceAccount string	DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
serviceAccountName string	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md
subdomain string	If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
volumes Volume array	List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

PodStatus v1

Field	Description
conditions PodCondition array	Current service state of pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions
containerStatuses ContainerStatus array	The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses
hostIP string	IP address of the host to which the pod is assigned. Empty if not yet scheduled.
message string	A human readable message indicating details about why the pod is in this condition.
phase string	Current condition of the pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase
podIP string	IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
reason string	A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk'
startTime Time	RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

PodList v1

Field	Description
apiVersion string	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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items Pod array	List of pods. More info: http://kubernetes.io/docs/user-guide/pods
kind string	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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta	Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

create a Pod

HTTP Request

POST /api/v1/namespaces/{namespace}/pods

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body Pod

Response

Code	Description
200 Pod	OK

Replace

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

replace the specified Pod

HTTP Request

PUT /api/v1/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body Pod

Response

Code	Description
200 Pod	OK

Patch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

partially update the specified Pod

HTTP Request

PATCH /api/v1/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body Patch

Response

Code	Description
200 Pod	OK

Delete

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete a Pod

HTTP Request

DELETE /api/v1/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
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.
orphanDependents	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.

Body Parameters

Parameter	Description
body DeleteOptions

Response

Code	Description
200 Status	OK

Delete Collection

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

delete collection of Pod

HTTP Request

DELETE /api/v1/namespaces/{namespace}/pods

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Status	OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

read the specified Pod

HTTP Request

GET /api/v1/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
exact	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
export	Should this value be exported. Export strips fields that a user can not specify.

Response

Code	Description
200 Pod	OK

List

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

list or watch objects of kind Pod

HTTP Request

GET /api/v1/namespaces/{namespace}/pods

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 PodList	OK

List All Namespaces

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

list or watch objects of kind Pod

HTTP Request

GET /api/v1/pods

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 PodList	OK

Watch

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

watch changes to an object of kind Pod

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK

Watch List

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

watch individual changes to a list of Pod

HTTP Request

GET /api/v1/watch/namespaces/{namespace}/pods

Path Parameters

Parameter	Description
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK

Watch List All Namespaces

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

watch individual changes to a list of Pod

HTTP Request

GET /api/v1/watch/pods

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK

Proxy Operations

See supported operations below...

Create Connect Portforward

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect POST requests to portforward of Pod

HTTP Request

POST /api/v1/namespaces/{namespace}/pods/{name}/portforward

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Response

Code	Description
200 string	OK

Create Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect POST requests to proxy of Pod

HTTP Request

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Create Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect POST requests to proxy of Pod

HTTP Request

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Create Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy POST requests to Pod

HTTP Request

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Response

Code	Description
200 string	OK

Create Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy POST requests to Pod

HTTP Request

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Response

Code	Description
200 string	OK

Delete Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect DELETE requests to proxy of Pod

HTTP Request

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Delete Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect DELETE requests to proxy of Pod

HTTP Request

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Delete Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy DELETE requests to Pod

HTTP Request

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Response

Code	Description
200 string	OK

Delete Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy DELETE requests to Pod

HTTP Request

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Response

Code	Description
200 string	OK

Get Connect Portforward

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect GET requests to portforward of Pod

HTTP Request

GET /api/v1/namespaces/{namespace}/pods/{name}/portforward

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Response

Code	Description
200 string	OK

Get Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect GET requests to proxy of Pod

HTTP Request

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Get Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect GET requests to proxy of Pod

HTTP Request

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Get Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy GET requests to Pod

HTTP Request

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Response

Code	Description
200 string	OK

Get Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy GET requests to Pod

HTTP Request

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Response

Code	Description
200 string	OK

Head Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect HEAD requests to proxy of Pod

HTTP Request

HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Head Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect HEAD requests to proxy of Pod

HTTP Request

HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Replace Connect Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect PUT requests to proxy of Pod

HTTP Request

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Replace Connect Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

connect PUT requests to proxy of Pod

HTTP Request

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Query Parameters

Parameter	Description
path	Path is the URL path to use for the current proxy request to pod.

Response

Code	Description
200 string	OK

Replace Proxy

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy PUT requests to Pod

HTTP Request

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Response

Code	Description
200 string	OK

Replace Proxy Path

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

proxy PUT requests to Pod

HTTP Request

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects
path	path to the resource

Response

Code	Description
200 string	OK

Misc Operations

See supported operations below...

Read Log

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

read log of the specified Pod

HTTP Request

GET /api/v1/namespaces/{namespace}/pods/{name}/log

Path Parameters

Parameter	Description
name	name of the Pod
namespace	object name and auth scope, such as for teams and projects

Query Parameters

Parameter	Description
container	The container for which to stream logs. Defaults to only container if there is one container in the pod.
follow	Follow the log stream of the pod. Defaults to false.
limitBytes	If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
pretty	If 'true', then the output is pretty printed.
previous	Return previous terminated container logs. Defaults to false.
sinceSeconds	A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
sinceTime	An RFC3339 timestamp from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
tailLines	If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
timestamps	If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

Response

Code	Description
200 string	OK

41 KiB Raw Blame History

Pod v1

PodSpec v1

PodStatus v1

PodList v1

Write Operations

Create

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Replace

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Patch

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Delete

HTTP Request

Path Parameters

Query Parameters

Body Parameters

Response

Delete Collection

HTTP Request

Path Parameters

Query Parameters

Response

Read Operations

Read

HTTP Request

Path Parameters

Query Parameters

Response

List

HTTP Request

Path Parameters

Query Parameters

Response

List All Namespaces

HTTP Request

Query Parameters

Response

Watch

HTTP Request

Path Parameters

Query Parameters

Response

Watch List

HTTP Request

Path Parameters

Query Parameters

Response

Watch List All Namespaces

HTTP Request

Query Parameters

Response

Proxy Operations

Create Connect Portforward

HTTP Request

Path Parameters

Response

Create Connect Proxy

HTTP Request

Path Parameters

Query Parameters

Response

Create Connect Proxy Path

HTTP Request

Path Parameters

Query Parameters

Response

Create Proxy

41 KiB

Raw Blame History