5.23.1 Reload Blackbox exporter
- Description
-
Reloads the Blackbox exporter definition file and reflects the operation of the Blackbox exporter.
Reloading the Blackbox exporter is faster than restarting the Blackbox exporter and maintains the state it was in when the notification failed.
- Format
-
- Request line
POST /-/reload HTTP/1.1
- Request header
-
Header name
Setup values
Host
Specify the value of the header for Alertmanager host to which API is connected, in the following format:
host-name-or-IP-address:port-number
":port-number" is optional.
-
host-name-or-IP-address
Specify the host name or IPv4 address of Alertmanager.
-
port-number
Specify the port number to use when connecting to Alertmanager.
This header is not optional.
-
- Request message body
-
None
- Response message body
-
If the reload is successful, there is no response.
If the reload fails, a message (the value printed by the Blackbox exporter) is set indicating the cause of the failure.
- Status codes
-
Status code
Message
Description
200
OK
Reloaded successfully.
Other than 200
Other than OK
Reload failed.
- Notes
-
-
If you reload an invalid definition file, all contents of the imported definition file will be invalidated.
-
The reload will take effect from the next Blackbox exporter API (such as scrape) and will not affect the running API.
-
- Examples
-
The following is an example of using this API using the OSS curl command.
On successful reload:
>curl --request POST "http://localhost:20715/-/reload" >
On reload failure:
# curl -request POST http://localhost:20715/-/reload failed to reload config: error parsing config file: yaml: unmarshal errors: line 3: field priber not found in type config.plain