Reports Agent and local source health.

POST

/api/workspace/file-protection/agent/v1/heartbeat

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/file-protection/agent/v1/heartbeat"),
    Headers =
    {
        { "X-Moltaro-File-Protection-Agent", "<X-Moltaro-File-Protection-Agent>" },
    },
    Content = new StringContent("{ \"AgentVersion\": \"example\", \"OperatingSystem\": 0, \"ObservedAtUtc\": \"2026-04-15T12:00:00Z\", \"Sources\": [ { \"SourceId\": \"example\", \"LogicalName\": \"example\", \"Kind\": 0, \"Tags\": [ \"example\" ], \"IsMapped\": true, \"ObservedSizeBytes\": 1, \"LastWriteAtUtc\": \"2026-04-15T12:00:00Z\", \"AssignmentRevision\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"KindDeclarationRevision\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ], \"ProtocolVersion\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/file-protection/agent/v1/heartbeat';
const options = {
  method: 'POST',
  headers: {
    'X-Moltaro-File-Protection-Agent': '<X-Moltaro-File-Protection-Agent>',
    'Content-Type': 'application/json'
  },
  body: '{"AgentVersion":"example","OperatingSystem":0,"ObservedAtUtc":"2026-04-15T12:00:00Z","Sources":[{"SourceId":"example","LogicalName":"example","Kind":0,"Tags":["example"],"IsMapped":true,"ObservedSizeBytes":1,"LastWriteAtUtc":"2026-04-15T12:00:00Z","AssignmentRevision":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","KindDeclarationRevision":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}],"ProtocolVersion":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/file-protection/agent/v1/heartbeat \
  --header 'Content-Type: application/json' \
  --header 'X-Moltaro-File-Protection-Agent: <X-Moltaro-File-Protection-Agent>' \
  --data '{ "AgentVersion": "example", "OperatingSystem": 0, "ObservedAtUtc": "2026-04-15T12:00:00Z", "Sources": [ { "SourceId": "example", "LogicalName": "example", "Kind": 0, "Tags": [ "example" ], "IsMapped": true, "ObservedSizeBytes": 1, "LastWriteAtUtc": "2026-04-15T12:00:00Z", "AssignmentRevision": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "KindDeclarationRevision": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ], "ProtocolVersion": "example" }'

Requires TLS at the API connection. A workspace bearer token does not authenticate an Agent.

Send the enrolled device credential in the X-Moltaro-File-Protection-Agent header. Revoked or invalid credentials are rejected.

Authorizations

FileProtectionAgent

Request Body

Periodic Agent health and mapping report.

object

AgentVersion

string

nullable

OperatingSystem

Operating systems supported by the universal File Protection tools.

integer format: int32

Allowed values: 0 1

ObservedAtUtc

string format: date-time

Sources

Array<object>

nullable

Safe logical metadata reported for one locally mapped source.

object

SourceId

string

nullable

LogicalName

string

nullable

Kind

required

Source selector interpreted only by the local Agent.

integer format: int32

Allowed values: 0 1 2

Tags

Array<string>

nullable

IsMapped

boolean

ObservedSizeBytes

integer format: int64

nullable

LastWriteAtUtc

string format: date-time

nullable

AssignmentRevision

string format: uuid

KindDeclarationRevision

string format: uuid

ProtocolVersion

string

nullable

Responses

200

application/json

object

Data

Heartbeat acknowledgement and current suspension state.

object

ServerTimeUtc

string format: date-time

ProtectionSuspended

boolean

CredentialRevoked

boolean

Sources

Array<object>

nullable

One current assignment fence and the confirmed selector; no physical path is transported.

object

SourceId

string

nullable

AssignmentRevision

string format: uuid

KindDeclarationRevision

string format: uuid

ConfirmedKind

Source selector interpreted only by the local Agent.

integer format: int32

Allowed values: 0 1 2

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Sources": [
      {
        "ConfirmedKind": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}