Skip to content
MoltaroMoltaroMoltaro Docs

Begins a fenced metadata scan without reading backup contents.

POST
/api/workspace/file-protection/agent/v1/observations:begin
curl --request POST \
  --url https://example.com/api/workspace/file-protection/agent/v1/observations:begin \
  --header 'Content-Type: application/json' \
  --header 'X-Moltaro-File-Protection-Agent: <X-Moltaro-File-Protection-Agent>' \
  --data '{ "SourceId": "example", "AssignmentRevision": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ExpectedGeneration": 1, "ScanId": "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

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Obtains a server generation before any filesystem work; retries use the same ScanId.

object
SourceId
string
nullable
AssignmentRevision
string format: uuid
ExpectedGeneration
integer format: int64
ScanId
string format: uuid
ProtocolVersion
string
nullable
Examplegenerated
{
  "SourceId": "example",
  "AssignmentRevision": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ExpectedGeneration": 1,
  "ScanId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ProtocolVersion": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data
object
Generation
integer format: int64
StartedAtUtc
string format: date-time
ExpiresAtUtc
string format: date-time
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
{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}