v1

latestSwagger 2.02026-07-178567199.3 KB
sources
kapacitors

Update kapacitor configuration

patch/sources/{id}/kapacitors/{kapa_id}

Path parameters

idstring required

ID of the source

kapa_idstring required

ID of a kapacitor backend

Request body

idstring

Unique identifier representing a kapacitor instance.

namestring required

User facing name of kapacitor instance.

usernamestring

Username for authentication to kapacitor.

passwordstring

Password is in cleartext.

urlstring url required

URL for the kapacitor backend (e.g. http://localhost:9092)

insecureSkipVerifyboolean

True means any certificate presented by the kapacitor is accepted. Typically used for self-signed certs. Probably should only be used for testing.

activeboolean

Indicates whether the kapacitor is the current kapacitor being used for a source

Example request

{
  "id": "4",
  "name": "kapa",
  "url": "http://localhost:9092",
  "active": false,
  "insecureSkipVerify": false,
  "links": {
    "proxy": "/chronograf/v1/sources/4/kapacitors/4/proxy",
    "self": "/chronograf/v1/sources/4/kapacitors/4",
    "rules": "/chronograf/v1/sources/4/kapacitors/4/rules"
  }
}

Response

Kapacitor's configuration was changed

idstring

Unique identifier representing a kapacitor instance.

namestring required

User facing name of kapacitor instance.

usernamestring

Username for authentication to kapacitor.

passwordstring

Password is in cleartext.

urlstring url required

URL for the kapacitor backend (e.g. http://localhost:9092)

insecureSkipVerifyboolean

True means any certificate presented by the kapacitor is accepted. Typically used for self-signed certs. Probably should only be used for testing.

activeboolean

Indicates whether the kapacitor is the current kapacitor being used for a source

Example response

{
  "id": "4",
  "name": "kapa",
  "url": "http://localhost:9092",
  "active": false,
  "insecureSkipVerify": false,
  "links": {
    "proxy": "/chronograf/v1/sources/4/kapacitors/4/proxy",
    "self": "/chronograf/v1/sources/4/kapacitors/4",
    "rules": "/chronograf/v1/sources/4/kapacitors/4/rules"
  }
}