ServiceMonitor [monitoring.coreos.com/v1] - Monitoring APIs | API reference

Specification
API endpoints

Description

ServiceMonitor defines monitoring for a set of services.

Type

object

Required

spec

Specification

Property Type Description

Property	Type	Description
`.apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`.kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`.spec`	`object`	Specification of desired Service selection for target discovery by Prometheus.

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

.spec

object

Specification of desired Service selection for target discovery by Prometheus.

.spec

Description

Specification of desired Service selection for target discovery by Prometheus.

Type

object

Required

endpoints
selector

Property Type Description

Property	Type	Description
`endpoints`	`array`	A list of endpoints allowed as part of this ServiceMonitor.
`endpoints[]`	`object`	Endpoint defines a scrapeable endpoint serving Prometheus metrics.
`jobLabel`	`string`	The label to use to retrieve the job name from.
`namespaceSelector`	`object`	Selector to select which namespaces the Endpoints objects are discovered from.
`podTargetLabels`	`array (string)`	PodTargetLabels transfers labels on the Kubernetes Pod onto the target.
`sampleLimit`	`integer`	SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.
`selector`	`object`	Selector to select Endpoints objects.
`targetLabels`	`array (string)`	TargetLabels transfers labels on the Kubernetes Service onto the target.

endpoints

array

A list of endpoints allowed as part of this ServiceMonitor.

endpoints[]

object

Endpoint defines a scrapeable endpoint serving Prometheus metrics.

jobLabel

string

The label to use to retrieve the job name from.

namespaceSelector

object

Selector to select which namespaces the Endpoints objects are discovered from.

podTargetLabels

array (string)

PodTargetLabels transfers labels on the Kubernetes Pod onto the target.

sampleLimit

integer

SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.

selector

object

Selector to select Endpoints objects.

targetLabels

array (string)

TargetLabels transfers labels on the Kubernetes Service onto the target.

.spec.endpoints

Description: A list of endpoints allowed as part of this ServiceMonitor.
Type: array

.spec.endpoints[]

Description: Endpoint defines a scrapeable endpoint serving Prometheus metrics.
Type: object

Property Type Description

Property	Type	Description
`basicAuth`	`object`	BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints
`bearerTokenFile`	`string`	File to read bearer token for scraping targets.
`bearerTokenSecret`	`object`	Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.
`honorLabels`	`boolean`	HonorLabels chooses the metric’s labels on collisions with target labels.
`honorTimestamps`	`boolean`	HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.
`interval`	`string`	Interval at which metrics should be scraped
`metricRelabelings`	`array`	MetricRelabelConfigs to apply to samples before ingestion.
`metricRelabelings[]`	`object`	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
`params`	`object`	Optional HTTP URL parameters
`params{}`	`array (string)`
`path`	`string`	HTTP path to scrape for metrics.
`port`	`string`	Name of the service port this endpoint refers to. Mutually exclusive with targetPort.
`proxyUrl`	`string`	ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.
`relabelings`	`array`	RelabelConfigs to apply to samples before scraping. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
`relabelings[]`	`object`	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
`scheme`	`string`	HTTP scheme to use for scraping.
`scrapeTimeout`	`string`	Timeout after which the scrape is ended
`targetPort`	`integer-or-string`	Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with port.
`tlsConfig`	`object`	TLS configuration to use when scraping the endpoint

basicAuth

object

BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints

bearerTokenFile

string

File to read bearer token for scraping targets.

bearerTokenSecret

object

Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.

honorLabels

boolean

HonorLabels chooses the metric’s labels on collisions with target labels.

honorTimestamps

boolean

HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.

interval

string

Interval at which metrics should be scraped

metricRelabelings

array

MetricRelabelConfigs to apply to samples before ingestion.

metricRelabelings[]

object

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

params

object

Optional HTTP URL parameters

params{}

array (string)

path

string

HTTP path to scrape for metrics.

port

string

Name of the service port this endpoint refers to. Mutually exclusive with targetPort.

proxyUrl

string

ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.

relabelings

array

RelabelConfigs to apply to samples before scraping. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelings[]

object

scheme

string

HTTP scheme to use for scraping.

scrapeTimeout

string

Timeout after which the scrape is ended

targetPort

integer-or-string

Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with port.

tlsConfig

object

TLS configuration to use when scraping the endpoint

.spec.endpoints[].basicAuth

Description: BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints
Type: object

Property Type Description

Property	Type	Description
`password`	`object`	The secret in the service monitor namespace that contains the password for authentication.
`username`	`object`	The secret in the service monitor namespace that contains the username for authentication.

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

.spec.endpoints[].basicAuth.password

Description

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.endpoints[].basicAuth.username

Description

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.endpoints[].bearerTokenSecret

Description

Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.endpoints[].metricRelabelings

Description: MetricRelabelConfigs to apply to samples before ingestion.
Type: array

.spec.endpoints[].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

Property	Type	Description
`action`	`string`	Action to perform based on regex matching. Default is 'replace'
`modulus`	`integer`	Modulus to take of the hash of the source label values.
`regex`	`string`	Regular expression against which the extracted value is matched. Default is '(.*)'
`replacement`	`string`	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
`separator`	`string`	Separator placed between concatenated source label values. default is ';'.
`sourceLabels`	`array (string)`	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.
`targetLabel`	`string`	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.

action

string

Action to perform based on regex matching. Default is 'replace'

modulus

integer

Modulus to take of the hash of the source label values.

regex

string

Regular expression against which the extracted value is matched. Default is '(.*)'

replacement

string

Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'

separator

string

Separator placed between concatenated source label values. default is ';'.

sourceLabels

array (string)

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.

targetLabel

string

Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.

.spec.endpoints[].params

Description: Optional HTTP URL parameters
Type: object

.spec.endpoints[].relabelings

Description: RelabelConfigs to apply to samples before scraping. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
Type: array

.spec.endpoints[].relabelings[]

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

Property	Type	Description
`action`	`string`	Action to perform based on regex matching. Default is 'replace'
`modulus`	`integer`	Modulus to take of the hash of the source label values.
`regex`	`string`	Regular expression against which the extracted value is matched. Default is '(.*)'
`replacement`	`string`	Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'
`separator`	`string`	Separator placed between concatenated source label values. default is ';'.
`sourceLabels`	`array (string)`	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.
`targetLabel`	`string`	Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.

action

string

Action to perform based on regex matching. Default is 'replace'

modulus

integer

Modulus to take of the hash of the source label values.

regex

string

Regular expression against which the extracted value is matched. Default is '(.*)'

replacement

string

Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'

separator

string

Separator placed between concatenated source label values. default is ';'.

sourceLabels

array (string)

targetLabel

string

Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.

.spec.endpoints[].tlsConfig

Description: TLS configuration to use when scraping the endpoint
Type: object

Property Type Description

Property	Type	Description
`ca`	`object`	Stuct containing the CA cert to use for the targets.
`caFile`	`string`	Path to the CA cert in the Prometheus container to use for the targets.
`cert`	`object`	Struct containing the client cert file for the targets.
`certFile`	`string`	Path to the client cert file in the Prometheus container for the targets.
`insecureSkipVerify`	`boolean`	Disable target certificate validation.
`keyFile`	`string`	Path to the client key file in the Prometheus container for the targets.
`keySecret`	`object`	Secret containing the client key file for the targets.
`serverName`	`string`	Used to verify the hostname for the targets.

ca

object

Stuct containing the CA cert to use for the targets.

caFile

string

Path to the CA cert in the Prometheus container to use for the targets.

cert

object

Struct containing the client cert file for the targets.

certFile

string

Path to the client cert file in the Prometheus container for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keyFile

string

Path to the client key file in the Prometheus container for the targets.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

.spec.endpoints[].tlsConfig.ca

Description: Stuct containing the CA cert to use for the targets.
Type: object

Property Type Description

Property	Type	Description
`configmap`	`object`	configmap containing data to use for the targets.
`secret`	`object`	Secret containing data to use for the targets.

configmap

object

configmap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.endpoints[].tlsConfig.ca.configmap

Description

configmap containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key to select.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the configmap or its key must be defined

key

string

The key to select.

name

string

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?

optional

boolean

Specify whether the configmap or its key must be defined

.spec.endpoints[].tlsConfig.ca.secret

Description

Secret containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.endpoints[].tlsConfig.cert

Description: Struct containing the client cert file for the targets.
Type: object

Property Type Description

Property	Type	Description
`configmap`	`object`	configmap containing data to use for the targets.
`secret`	`object`	Secret containing data to use for the targets.

configmap

object

configmap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.endpoints[].tlsConfig.cert.configmap

Description

configmap containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key to select.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the configmap or its key must be defined

key

string

The key to select.

name

string

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?

optional

boolean

Specify whether the configmap or its key must be defined

.spec.endpoints[].tlsConfig.cert.secret

Description

Secret containing data to use for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.endpoints[].tlsConfig.keySecret

Description

Secret containing the client key file for the targets.

Type

object

Required

key

Property Type Description

Property	Type	Description
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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?
`optional`	`boolean`	Specify whether the Secret or its key must be defined

key

string

The key of the secret to select from. Must be a valid secret key.

name

string

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?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.namespaceSelector

Description: Selector to select which namespaces the Endpoints objects are discovered from.
Type: object

Property Type Description

Property	Type	Description
`any`	`boolean`	Boolean describing whether all namespaces are selected in contrast to a list restricting them.
`matchNames`	`array (string)`	List of namespace names.

any

boolean

Boolean describing whether all namespaces are selected in contrast to a list restricting them.

matchNames

array (string)

List of namespace names.

.spec.selector

Description: Selector to select Endpoints objects.
Type: object

Property Type Description

Property	Type	Description
`matchExpressions`	`array`	matchExpressions is a list of label selector requirements. The requirements are ANDed.
`matchExpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (string)`	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.

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

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.selector.matchExpressions

Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.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

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
`values`	`array (string)`	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.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

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.

API endpoints

The following API endpoints are available:

/apis/monitoring.coreos.com/v1/servicemonitors
- GET: list objects of kind ServiceMonitor
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors
- DELETE: delete collection of ServiceMonitor
- GET: list objects of kind ServiceMonitor
- POST: create a ServiceMonitor
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name}
- DELETE: delete a ServiceMonitor
- GET: read the specified ServiceMonitor
- PATCH: partially update the specified ServiceMonitor
- PUT: replace the specified ServiceMonitor

/apis/monitoring.coreos.com/v1/servicemonitors

Table 1. Global guery parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	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.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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`	`string`	If 'true', then the output is pretty printed.
`resourceVersion`	`string`	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`	`string`	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
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	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 ServiceMonitor

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`ServiceMonitorList monitoring.coreos.com/v1`
401 - Unauthorized	Empty

/apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors

Table 3. Global path parameters
Parameter	Type	Description
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of ServiceMonitor

Table 5. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	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.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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`	`string`	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`	`string`	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
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind ServiceMonitor

Table 7. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	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.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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`	`string`	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`	`string`	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
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`ServiceMonitorList monitoring.coreos.com/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ServiceMonitor

Table 9. Query parameters
Parameter	Type	Description
`dryRun`	`string`	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`	`string`	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.

Table 10. Body parameters
Parameter	Type	Description
`body`	`ServiceMonitor monitoring.coreos.com/v1`

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ServiceMonitor monitoring.coreos.com/v1`
201 - Created	`ServiceMonitor monitoring.coreos.com/v1`
202 - Accepted	`ServiceMonitor monitoring.coreos.com/v1`
401 - Unauthorized	Empty

/apis/monitoring.coreos.com/v1/namespaces/{namespace}/servicemonitors/{name}

Table 12. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ServiceMonitor
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 13. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a ServiceMonitor

Table 14. Query parameters
Parameter	Type	Description
`dryRun`	`string`	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
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	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.
`propagationPolicy`	`string`	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.

Table 15. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
202 - Accepted	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ServiceMonitor

Table 17. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	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

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ServiceMonitor monitoring.coreos.com/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ServiceMonitor

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	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`	`string`	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.

Table 20. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`ServiceMonitor monitoring.coreos.com/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ServiceMonitor

Table 22. Query parameters
Parameter	Type	Description
`dryRun`	`string`	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`	`string`	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.

Table 23. Body parameters
Parameter	Type	Description
`body`	`ServiceMonitor monitoring.coreos.com/v1`

Table 24. HTTP responses
HTTP code	Reponse body
200 - OK	`ServiceMonitor monitoring.coreos.com/v1`
201 - Created	`ServiceMonitor monitoring.coreos.com/v1`
401 - Unauthorized	Empty