Monitoring

Create monitoring instance

Changed on Aug 27, 2024

This API creates a new monitoring instance.

A monitoring instance object requires type to be set. Based on the type the respective key with configuration needs to be set. Such as, if type: pmm, then pmm key needs to be provided with a configuration.

post/namespaces/{namespace}/monitoring-instances

Request

Base URL
/v1 (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/openeverest/apis/openeverest-schema/docs/namespaces/:namespace/monitoring-instances/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namespacestring required

Namespace of the backup storage

Request body

type'pmm' required

urlstring required

allowedNamespacesstring[]

List of namespaces allowed to use this monitoring instance

verifyTLSboolean

VerifyTLS is set to ensure TLS/SSL verification.

namestring required

A user defined string name of the storage in the DNS name format https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names

namespacestring

Example request

{
  "name": "pmm-instance",
  "pmm": {
    "user": "admin",
    "password": "password",
    "apiKey": "apikey"
  }
}

Response

Successful operation

type'pmm'

urlstring