Returns the authorized operational overview.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/file-protection"), Headers = { { "Authorization", "Bearer <token>" }, },};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';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/file-protection \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Operational File Protection overview visible to an authorized actor.
object
Safe state of one enrolled backup Agent.
object
Operating systems supported by the universal File Protection tools.
Lifecycle state reported for an enrolled Agent.
Compact active signal summary for object grids.
object
Exact active type/severity association for combined grid filters.
object
Required Agent software for the current installation instructions.
Connection availability does not establish software compatibility.
Safe logical protection source without a physical machine path.
object
State of one logical protection source.
Safe manual run projection.
object
Supported backup command kinds. Restore is deliberately absent.
Durable state of one manual protection run.
The authority which accepted a protection operation.
Successful operation result; completion includes server verification or renewal.
Observed blockers. A deadline applies only while waiting; useful work pauses the budget.
object
Safe removal progress. Cancellation ends when irreversible cleanup starts.
object
Source selector interpreted only by the local Agent.
Once used, a confirmed local kind cannot be changed by another configuration.
Current source-scoped permissions; commands still authorize every request.
Source-owned schedule, independent of its configuring user’s account.
object
Latest durable schedule decision and its authorized operation.
object
Safe manual run projection.
object
Supported backup command kinds. Restore is deliberately absent.
Durable state of one manual protection run.
The authority which accepted a protection operation.
Successful operation result; completion includes server verification or renewal.
Observed blockers. A deadline applies only while waiting; useful work pauses the budget.
object
Compact active signal summary for object grids.
object
Exact active type/severity association for combined grid filters.
object
Current workspace-scoped permissions usable for page-level actions.
object
object
object
object
Example
{ "Data": { "Agents": [ { "OperatingSystem": 0, "State": 0, "SignalSummary": { "Severity": 1, "PolicyKinds": [ 0 ], "Conditions": [ { "PolicyKind": 0, "Severity": 1 } ] } } ], "Sources": [ { "State": 0, "LatestRun": { "Kind": 0, "State": 0, "Origin": 0, "Outcome": 0 }, "ConfirmedKind": 0, "LatestScheduleOccurrence": { "Run": { "Kind": 0, "State": 0, "Origin": 0, "Outcome": 0 } }, "SignalSummary": { "Severity": 1, "PolicyKinds": [ 0 ], "Conditions": [ { "PolicyKind": 0, "Severity": 1 } ] } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}