Check secret password (Heartbeat)
curl --request POST \
--url https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat \
--header 'Authorization: <api-key>'import requests
url = "https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"check_password_status": "Valid"
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}Endpoints
Heartbeat (Check Password)
Syteca ACB REST API endpoint — NEW in v1.4 — to verify a secret’s password is still valid on the target endpoint without modifying it. Useful for detecting drift between Syteca and the target system.
POST
/
api
/
secrets
/
{id}
/
heartbeat
Check secret password (Heartbeat)
curl --request POST \
--url https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat \
--header 'Authorization: <api-key>'import requests
url = "https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-syteca-host/SytecaACB/api/secrets/{id}/heartbeat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"check_password_status": "Valid"
}{
"status": 123,
"message": "<string>"
}{
"status": 123,
"message": "<string>"
}NEW in ACB v1.4. Not available in v1.3 and earlier. Confirm your installed ACB version supports this endpoint before scripting against it.
For ACB deployments updated from a version prior to 1.2, switch to the
https://{hostname}/EkranACB server in the Playground.Permissions required
The user owning the Access Token must have Editor or Owner role on the secret.Status values returned
The response includes acheck_password_status field with one of four PasswordCheckStatus values:
None— No check has been performed yet.Valid— The password is valid on the target endpoint.Invalid— The password is not valid (drift detected — consider rotating).Failed— The check itself failed (target unreachable, network error, etc.).
Scheduled heartbeat checks — rather than calling this endpoint manually, configure the secret with
check_password: { enabled: true, check_every: 1, check_period_type: "Hour" } via Add secret or Update secret. Syteca then runs heartbeat checks automatically on schedule, and you read the result from the check_password_status field on GET /api/secrets/{id}.Use the manual heartbeat endpoint for on-demand verification — after suspected drift, after a target-system maintenance window, or as part of an incident-response playbook.Errors
- 403 Forbidden — user lacks Editor/Owner role.
- 404 Not Found — secret doesn’t exist.
Related
Get secret
Read scheduled heartbeat results via
check_password_status.Rotate password
If heartbeat returns Invalid, rotate to fix drift.
Data models — CheckPassword
Schedule heartbeat checks per secret.
Data models — status enum
PasswordCheckStatus values.
Authorizations
Access token for authentication
Path Parameters
The ID of the secret to check
Required range:
x >= 1Response
Heartbeat check completed successfully
Status of the last password check (heartbeat)
Available options:
None, Valid, Invalid, Failed