POST /api/v1/services HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json' { "kind": "Service", "apiVersion": "v1", ... }
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.
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:
continue: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:publishNotReadyAddresses:selector:
[string]:sessionAffinity:sessionAffinityConfig:
clientIP:
timeoutSeconds:type:status:
loadBalancer:
ingress:
- hostname:ip:
Create a Service
POST /api/v1/services HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close Content-Type: application/json' { "kind": "Service", "apiVersion": "v1", ... }
$ 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
Create a Service
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 -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
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Read the specified Service
GET /api/v1/namespaces/$NAMESPACE/services/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
List or watch objects of kind Service
GET /api/v1/services HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/services
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
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. |
List or watch objects of kind Service
GET /api/v1/namespaces/$NAMESPACE/services HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
pretty |
If 'true', then the output is pretty printed. |
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
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. |
Watch changes to an object of kind Service
GET /api/v1/watch/namespaces/$NAMESPACE/services/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/watch/namespaces/$NAMESPACE/services/$NAME
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
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. |
Watch individual changes to a list of Service
GET /api/v1/watch/services HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/watch/services
Parameter | Description |
---|---|
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
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. |
Watch individual changes to a list of Service
GET /api/v1/watch/namespaces/$NAMESPACE/services HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/watch/namespaces/$NAMESPACE/services
Parameter | Description |
---|---|
namespace |
object name and auth scope, such as for teams and projects |
Parameter | Description |
---|---|
continue |
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
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. |
limit |
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
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. |
Replace the specified Service
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 -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
Partially update the specified Service
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 -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
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Delete a Service
DELETE /api/v1/namespaces/$NAMESPACE/services/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X DELETE \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME
Read status of the specified Service
GET /api/v1/namespaces/$NAMESPACE/services/$NAME/status HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/status
Replace status of the specified Service
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 -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
Partially update status of the specified Service
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 -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
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
Connect OPTIONS requests to proxy of Service
OPTIONS /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X OPTIONS \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
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. |
Connect POST requests to proxy of Service
POST /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X POST \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
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. |
Connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X HEAD \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
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. |
Connect GET requests to proxy of Service
GET /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
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. |
Connect PUT requests to proxy of Service
PUT /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X PUT \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
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. |
Connect PATCH requests to proxy of Service
PATCH /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X PATCH \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
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. |
Connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X DELETE \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
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. |
Connect OPTIONS requests to proxy of Service
OPTIONS /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X OPTIONS \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
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. |
Connect POST requests to proxy of Service
POST /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X POST \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
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. |
Connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X HEAD \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
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. |
Connect GET requests to proxy of Service
GET /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
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. |
Connect PUT requests to proxy of Service
PUT /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X PUT \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
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. |
Connect PATCH requests to proxy of Service
PATCH /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X PATCH \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
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. |
Connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \ -X DELETE \ -H "Authorization: Bearer $TOKEN" \ -H 'Accept: application/json' \ https://$ENDPOINT/api/v1/namespaces/$NAMESPACE/services/$NAME/proxy/$PATH
Parameter | Description |
---|---|
name |
name of the Service |
namespace |
object name and auth scope, such as for teams and projects |
path |
path to the resource |
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. |