diff --git a/src/api2.rs b/src/api2.rs index 85d29ed2..27ef2975 100644 --- a/src/api2.rs +++ b/src/api2.rs @@ -7,6 +7,7 @@ pub mod reader; pub mod status; pub mod types; pub mod version; +pub mod ping; pub mod pull; mod helpers; @@ -22,6 +23,7 @@ pub const SUBDIRS: SubdirMap = &[ ("backup", &backup::ROUTER), ("config", &config::ROUTER), ("nodes", &NODES_ROUTER), + ("ping", &ping::ROUTER), ("pull", &pull::ROUTER), ("reader", &reader::ROUTER), ("status", &status::ROUTER), diff --git a/src/api2/ping.rs b/src/api2/ping.rs new file mode 100644 index 00000000..087b1377 --- /dev/null +++ b/src/api2/ping.rs @@ -0,0 +1,29 @@ +use anyhow::{Error}; +use serde_json::{json, Value}; + +use proxmox::api::{api, Router, Permission}; + +#[api( + returns: { + description: "Dummy ping", + type: Object, + properties: { + pong: { + description: "Always true", + type: bool, + } + } + }, + access: { + description: "Anyone can access this, because it's used for a cheap check if the API daemon is online.", + permission: &Permission::World, + } +)] +/// Dummy method which replies with `{ "pong": True }` +fn ping() -> Result { + Ok(json!({ + "pong": true, + })) +} +pub const ROUTER: Router = Router::new() + .get(&API_METHOD_PING);