v1.Service

v1.Service

Description

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Object Schema

Expand or mouse-over a field for more information about it.

apiVersion:
kind:
metadata:
  annotations:
    [string]:
  clusterName:
  creationTimestamp:
  deletionGracePeriodSeconds:
  deletionTimestamp:
  finalizers:
  - [string]:
  generateName:
  generation:
  initializers:
    pending:
    - name:
    result:
      apiVersion:
      code:
      details:
        causes:
        - field:
          message:
          reason:
        group:
        kind:
        name:
        retryAfterSeconds:
        uid:
      kind:
      message:
      metadata:
        resourceVersion:
        selfLink:
      reason:
      status:
  labels:
    [string]:
  name:
  namespace:
  ownerReferences:
  - apiVersion:
    blockOwnerDeletion:
    controller:
    kind:
    name:
    uid:
  resourceVersion:
  selfLink:
  uid:
spec:
  clusterIP:
  externalIPs:
  - [string]:
  externalName:
  externalTrafficPolicy:
  healthCheckNodePort:
  loadBalancerIP:
  loadBalancerSourceRanges:
  - [string]:
  ports:
  - name:
    nodePort:
    port:
    protocol:
    targetPort:
  selector:
    [string]:
  sessionAffinity:
  type:
status:
  loadBalancer:
    ingress:
    - hostname:
      ip:

Operations

Create a Service

HTTP request

POST /api/v1/services HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/services <<'EOF'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Service

Query parameters

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

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Create a Service in a namespace

Create a Service

HTTP request

POST /api/v1/namespaces/$NAMESPACE/services HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X POST \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services <<'EOF'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Service

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.

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Get a Service in a namespace

Read the specified Service

HTTP request

GET /api/v1/namespaces/$NAMESPACE/services/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME

Path parameters

Parameter	Description
name	name of the Service
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.

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Get all Services

List or watch objects of kind Service

HTTP request

GET /api/v1/services HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/services

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.
includeUninitialized	If true, partially initialized resources are included in the response.
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. 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.
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.

Responses

HTTP Code	Schema
200 OK	v1.ServiceList
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Get all Services in a namespace

List or watch objects of kind Service

HTTP request

GET /api/v1/namespaces/$NAMESPACE/services HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services

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.
includeUninitialized	If true, partially initialized resources are included in the response.
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. 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.
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.

Responses

HTTP Code	Schema
200 OK	v1.ServiceList
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Watch a Service in a namespace

Watch changes to an object of kind Service

HTTP request

GET /api/v1/watch/namespaces/$NAMESPACE/services/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/watch/namespaces/$NAMESPACE/services/$NAME

Path parameters

Parameter	Description
name	name of the Service
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.
includeUninitialized	If true, partially initialized resources are included in the response.
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. 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.
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.

Responses

HTTP Code	Schema
200 OK	v1.WatchEvent
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Watch all Services

Watch individual changes to a list of Service

HTTP request

GET /api/v1/watch/services HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/watch/services

Query parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitialized	If true, partially initialized resources are included in the response.
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. 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.
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.

Responses

HTTP Code	Schema
200 OK	v1.WatchEvent
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Watch all Services in a namespace

Watch individual changes to a list of Service

HTTP request

GET /api/v1/watch/namespaces/$NAMESPACE/services HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/watch/namespaces/$NAMESPACE/services

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.
includeUninitialized	If true, partially initialized resources are included in the response.
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. 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.
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.

Responses

HTTP Code	Schema
200 OK	v1.WatchEvent
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf
application/json;stream=watch
application/vnd.kubernetes.protobuf;stream=watch

Update a Service in a namespace

Replace the specified Service

HTTP request

PUT /api/v1/namespaces/$NAMESPACE/services/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME <<'EOF'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Service

Path parameters

Parameter	Description
name	name of the Service
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.

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Patch a Service in a namespace

Partially update the specified Service

HTTP request

PATCH /api/v1/namespaces/$NAMESPACE/services/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Patch

Path parameters

Parameter	Description
name	name of the Service
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.

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Delete a Service in a namespace

Delete a Service

HTTP request

DELETE /api/v1/namespaces/$NAMESPACE/services/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME

Path parameters

Parameter	Description
name	name of the Service
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.

Responses

HTTP Code	Schema
200 OK	v1.Status
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Get status of a Service in a namespace

Read status of the specified Service

HTTP request

GET /api/v1/namespaces/$NAMESPACE/services/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/status

Path parameters

Parameter	Description
name	name of the Service
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.

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Update status of a Service in a namespace

Replace status of the specified Service

HTTP request

PUT /api/v1/namespaces/$NAMESPACE/services/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}

Curl request

$ curl -k \
    -X PUT \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/status <<'EOF'
{
  "kind": "Service",
  "apiVersion": "v1",
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Service

Path parameters

Parameter	Description
name	name of the Service
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.

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Patch status of a Service in a namespace

Partially update status of the specified Service

HTTP request

PATCH /api/v1/namespaces/$NAMESPACE/services/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
  ...
}

Curl request

$ curl -k \
    -X PATCH \
    -d @- \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json-patch+json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/status <<'EOF'
{
  ...
}
EOF

HTTP body

Parameter	Schema
body	v1.Patch

Path parameters

Parameter	Description
name	name of the Service
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.

Responses

HTTP Code	Schema
200 OK	v1.Service
401 Unauthorized

Consumes

application/json-patch+json
application/merge-patch+json
application/strategic-merge-patch+json

Produces

application/json
application/yaml
application/vnd.kubernetes.protobuf

Proxy OPTIONS request to a Service in a namespace

Connect OPTIONS requests to proxy of Service

HTTP request

OPTIONS /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X OPTIONS \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy

Path parameters

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

Query parameters

Parameter	Description
path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy POST request to a Service in a namespace

Connect POST requests to proxy of Service

HTTP request

POST /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X POST \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy

Path parameters

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

Query parameters

Parameter	Description
path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy HEAD request to a Service in a namespace

Connect HEAD requests to proxy of Service

HTTP request

HEAD /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X HEAD \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy

Path parameters

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

Query parameters

Parameter	Description
path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy GET request to a Service in a namespace

Connect GET requests to proxy of Service

HTTP request

GET /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy

Path parameters

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

Query parameters

Parameter	Description
path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy PUT request to a Service in a namespace

Connect PUT requests to proxy of Service

HTTP request

PUT /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X PUT \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy

Path parameters

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

Query parameters

Parameter	Description
path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy PATCH request to a Service in a namespace

Connect PATCH requests to proxy of Service

HTTP request

PATCH /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X PATCH \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy

Path parameters

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

Query parameters

Parameter	Description
path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy DELETE request to a Service in a namespace

Connect DELETE requests to proxy of Service

HTTP request

DELETE /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy

Path parameters

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

Query parameters

Parameter	Description
path	Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy OPTIONS request to a Service in a namespace (with path)

Connect OPTIONS requests to proxy of Service

HTTP request

OPTIONS /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X OPTIONS \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Service
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 part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy POST request to a Service in a namespace (with path)

Connect POST requests to proxy of Service

HTTP request

POST /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X POST \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Service
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 part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy HEAD request to a Service in a namespace (with path)

Connect HEAD requests to proxy of Service

HTTP request

HEAD /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X HEAD \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Service
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 part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy GET request to a Service in a namespace (with path)

Connect GET requests to proxy of Service

HTTP request

GET /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Service
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 part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy PUT request to a Service in a namespace (with path)

Connect PUT requests to proxy of Service

HTTP request

PUT /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X PUT \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Service
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 part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy PATCH request to a Service in a namespace (with path)

Connect PATCH requests to proxy of Service

HTTP request

PATCH /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X PATCH \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Service
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 part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized

Consumes

Produces

Proxy DELETE request to a Service in a namespace (with path)

Connect DELETE requests to proxy of Service

HTTP request

DELETE /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close

Curl request

$ curl -k \
    -X DELETE \
    -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' \
    https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH

Path parameters

Parameter	Description
name	name of the Service
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 part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

Responses

HTTP Code	Schema
200 OK	string
401 Unauthorized