- Probe [monitoring.coreos.com/v1]
- Specification
- .spec
- .spec.authorization
- .spec.authorization.credentials
- .spec.basicAuth
- .spec.basicAuth.password
- .spec.basicAuth.username
- .spec.bearerTokenSecret
- .spec.metricRelabelings
- .spec.metricRelabelings[]
- .spec.oauth2
- .spec.oauth2.clientId
- .spec.oauth2.clientId.configMap
- .spec.oauth2.clientId.secret
- .spec.oauth2.clientSecret
- .spec.prober
- .spec.targets
- .spec.targets.ingress
- .spec.targets.ingress.namespaceSelector
- .spec.targets.ingress.relabelingConfigs
- .spec.targets.ingress.relabelingConfigs[]
- .spec.targets.ingress.selector
- .spec.targets.ingress.selector.matchExpressions
- .spec.targets.ingress.selector.matchExpressions[]
- .spec.targets.staticConfig
- .spec.targets.staticConfig.relabelingConfigs
- .spec.targets.staticConfig.relabelingConfigs[]
- .spec.tlsConfig
- .spec.tlsConfig.ca
- .spec.tlsConfig.ca.configMap
- .spec.tlsConfig.ca.secret
- .spec.tlsConfig.cert
- .spec.tlsConfig.cert.configMap
- .spec.tlsConfig.cert.secret
- .spec.tlsConfig.keySecret
- API endpoints
- Specification
Probe [monitoring.coreos.com/v1]
Description
Probe defines monitoring for a set of static targets or ingresses.
Type
object
Required
spec
Specification
Property | Type | Description |
---|---|---|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| Specification of desired Ingress selection for target discovery by Prometheus. |
.spec
Description
Specification of desired Ingress selection for target discovery by Prometheus.
Type
object
Property | Type | Description |
---|---|---|
|
| Authorization section for this endpoint |
|
| BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint |
|
| Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the probe and accessible by the Prometheus Operator. |
|
| Interval at which targets are probed using the configured prober. If not specified Prometheus’ global scrape interval is used. |
|
| The job name assigned to scraped metrics by default. |
|
| Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. |
|
| Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. |
|
| Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. |
|
| MetricRelabelConfigs to apply to samples before ingestion. |
|
| RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines |
|
| The module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml |
|
| OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. |
|
| Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty. |
|
| SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. |
|
| Timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape interval is used. |
|
| TargetLimit defines a limit on the number of scraped targets that will be accepted. |
|
| Targets defines a set of static or dynamically discovered targets to probe. |
|
| TLS configuration to use when scraping the endpoint. |
.spec.authorization
Description
Authorization section for this endpoint
Type
object
Property | Type | Description |
---|---|---|
|
| The secret’s key that contains the credentials of the request |
|
| Set the authentication type. Defaults to Bearer, Basic will cause an error |
.spec.authorization.credentials
Description
The secret’s key that contains the credentials of the request
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.basicAuth
Description
BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint
Type
object
Property | Type | Description |
---|---|---|
|
| The secret in the service monitor namespace that contains the password for authentication. |
|
| The secret in the service monitor namespace that contains the username for authentication. |
.spec.basicAuth.password
Description
The secret in the service monitor namespace that contains the password for authentication.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.basicAuth.username
Description
The secret in the service monitor namespace that contains the username for authentication.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.bearerTokenSecret
Description
Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the probe and accessible by the Prometheus Operator.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.metricRelabelings
Description
MetricRelabelConfigs to apply to samples before ingestion.
Type
array
.spec.metricRelabelings[]
Description
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines <metric_relabel_configs>
-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
Type
object
Property | Type | Description |
---|---|---|
|
| Action to perform based on regex matching. Default is ‘replace’. uppercase and lowercase actions require Prometheus >= 2.36. |
|
| Modulus to take of the hash of the source label values. |
|
| Regular expression against which the extracted value is matched. Default is ‘(.*)’ |
|
| Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is ‘$1’ |
|
| Separator placed between concatenated source label values. default is ‘;’. |
|
| The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. |
|
| Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |
.spec.oauth2
Description
OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.
Type
object
Required
clientId
clientSecret
tokenUrl
Property | Type | Description |
---|---|---|
|
| The secret or configmap containing the OAuth2 client id |
|
| The secret containing the OAuth2 client secret |
|
| Parameters to append to the token URL |
|
| OAuth2 scopes used for the token request |
|
| The URL to fetch the token from |
.spec.oauth2.clientId
Description
The secret or configmap containing the OAuth2 client id
Type
object
Property | Type | Description |
---|---|---|
|
| ConfigMap containing data to use for the targets. |
|
| Secret containing data to use for the targets. |
.spec.oauth2.clientId.configMap
Description
ConfigMap containing data to use for the targets.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key to select. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the ConfigMap or its key must be defined |
.spec.oauth2.clientId.secret
Description
Secret containing data to use for the targets.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.oauth2.clientSecret
Description
The secret containing the OAuth2 client secret
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.prober
Description
Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty.
Type
object
Required
url
Property | Type | Description |
---|---|---|
|
| Path to collect metrics from. Defaults to |
|
| Optional ProxyURL. |
|
| HTTP scheme to use for scraping. Defaults to |
|
| Mandatory URL of the prober. |
.spec.targets
Description
Targets defines a set of static or dynamically discovered targets to probe.
Type
object
Property | Type | Description |
---|---|---|
|
| ingress defines the Ingress objects to probe and the relabeling configuration. If |
|
| staticConfig defines the static list of targets to probe and the relabeling configuration. If |
.spec.targets.ingress
Description
ingress defines the Ingress objects to probe and the relabeling configuration. If staticConfig
is also defined, staticConfig
takes precedence.
Type
object
Property | Type | Description |
---|---|---|
|
| From which namespaces to select Ingress objects. |
|
| RelabelConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the |
|
| RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines |
|
| Selector to select the Ingress objects. |
.spec.targets.ingress.namespaceSelector
Description
From which namespaces to select Ingress objects.
Type
object
Property | Type | Description |
---|---|---|
|
| Boolean describing whether all namespaces are selected in contrast to a list restricting them. |
|
| List of namespace names to select from. |
.spec.targets.ingress.relabelingConfigs
Description
RelabelConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the _tmp_prometheus_ingress_address_
label. It can be used to customize the probed URL. The original scrape job’s name is available via the tmp_prometheus_job_name
label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type
array
.spec.targets.ingress.relabelingConfigs[]
Description
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines <metric_relabel_configs>
-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
Type
object
Property | Type | Description |
---|---|---|
|
| Action to perform based on regex matching. Default is ‘replace’. uppercase and lowercase actions require Prometheus >= 2.36. |
|
| Modulus to take of the hash of the source label values. |
|
| Regular expression against which the extracted value is matched. Default is ‘(.*)’ |
|
| Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is ‘$1’ |
|
| Separator placed between concatenated source label values. default is ‘;’. |
|
| The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. |
|
| Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |
.spec.targets.ingress.selector
Description
Selector to select the Ingress objects.
Type
object
Property | Type | Description |
---|---|---|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
.spec.targets.ingress.selector.matchExpressions
Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
.spec.targets.ingress.selector.matchExpressions[]
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
key
operator
Property | Type | Description |
---|---|---|
|
| key is the label key that the selector applies to. |
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
.spec.targets.staticConfig
Description
staticConfig defines the static list of targets to probe and the relabeling configuration. If ingress
is also defined, staticConfig
takes precedence. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config.
Type
object
Property | Type | Description |
---|---|---|
|
| Labels assigned to all metrics scraped from the targets. |
|
| RelabelConfigs to apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
| RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines |
|
| The list of hosts to probe. |
.spec.targets.staticConfig.relabelingConfigs
Description
RelabelConfigs to apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type
array
.spec.targets.staticConfig.relabelingConfigs[]
Description
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines <metric_relabel_configs>
-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
Type
object
Property | Type | Description |
---|---|---|
|
| Action to perform based on regex matching. Default is ‘replace’. uppercase and lowercase actions require Prometheus >= 2.36. |
|
| Modulus to take of the hash of the source label values. |
|
| Regular expression against which the extracted value is matched. Default is ‘(.*)’ |
|
| Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is ‘$1’ |
|
| Separator placed between concatenated source label values. default is ‘;’. |
|
| The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. |
|
| Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |
.spec.tlsConfig
Description
TLS configuration to use when scraping the endpoint.
Type
object
Property | Type | Description |
---|---|---|
|
| Struct containing the CA cert to use for the targets. |
|
| Struct containing the client cert file for the targets. |
|
| Disable target certificate validation. |
|
| Secret containing the client key file for the targets. |
|
| Used to verify the hostname for the targets. |
.spec.tlsConfig.ca
Description
Struct containing the CA cert to use for the targets.
Type
object
Property | Type | Description |
---|---|---|
|
| ConfigMap containing data to use for the targets. |
|
| Secret containing data to use for the targets. |
.spec.tlsConfig.ca.configMap
Description
ConfigMap containing data to use for the targets.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key to select. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the ConfigMap or its key must be defined |
.spec.tlsConfig.ca.secret
Description
Secret containing data to use for the targets.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.tlsConfig.cert
Description
Struct containing the client cert file for the targets.
Type
object
Property | Type | Description |
---|---|---|
|
| ConfigMap containing data to use for the targets. |
|
| Secret containing data to use for the targets. |
.spec.tlsConfig.cert.configMap
Description
ConfigMap containing data to use for the targets.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key to select. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the ConfigMap or its key must be defined |
.spec.tlsConfig.cert.secret
Description
Secret containing data to use for the targets.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
.spec.tlsConfig.keySecret
Description
Secret containing the client key file for the targets.
Type
object
Required
key
Property | Type | Description |
---|---|---|
|
| The key of the secret to select from. Must be a valid secret key. |
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
| Specify whether the Secret or its key must be defined |
API endpoints
The following API endpoints are available:
/apis/monitoring.coreos.com/v1/probes
GET
: list objects of kind Probe
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes
DELETE
: delete collection of ProbeGET
: list objects of kind ProbePOST
: create a Probe
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}
DELETE
: delete a ProbeGET
: read the specified ProbePATCH
: partially update the specified ProbePUT
: replace the specified Probe
/apis/monitoring.coreos.com/v1/probes
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| 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. |
|
| If ‘true’, then the output is pretty printed. |
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP method
GET
Description
list objects of kind Probe
HTTP code | Reponse body |
---|---|
200 - OK | ProbeList schema |
401 - Unauthorized | Empty |
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes
Parameter | Type | Description |
---|---|---|
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete collection of Probe
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| 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 sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind Probe
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
| 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. 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. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| 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 sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK | ProbeList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a Probe
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Probe schema |
HTTP code | Reponse body |
---|---|
200 - OK | Probe schema |
201 - Created | Probe schema |
202 - Accepted | Probe schema |
401 - Unauthorized | Empty |
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the Probe |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
DELETE
Description
delete a Probe
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| 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. |
|
| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
|
| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground. |
Parameter | Type | Description |
---|---|---|
| DeleteOptions schema |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified Probe
Parameter | Type | Description |
---|---|---|
|
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
HTTP code | Reponse body |
---|---|
200 - OK | Probe schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified Probe
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Patch schema |
HTTP code | Reponse body |
---|---|
200 - OK | Probe schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified Probe
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
| Probe schema |
HTTP code | Reponse body |
---|---|
200 - OK | Probe schema |
201 - Created | Probe schema |
401 - Unauthorized | Empty |