Returns an authorized page of active, resolved or dismissed episodes.

GET

/api/workspace/file-protection/signals

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/signals?State=0&PolicyKind=0&Severity=1&DateField=0"),
    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/signals?State=0&PolicyKind=0&Severity=1&DateField=0';
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/signals?State=0&PolicyKind=0&Severity=1&DateField=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

SignalId

string

SourceId

string

AgentId

string

FileId

string

State

integer format: int32

Allowed values: 0 1 2

PolicyKind

integer format: int32

Allowed values: 0 1 2 3 4 5

Severity

integer format: int32

Allowed values: 1 2

SearchTerm

string

DateField

Date used by episode From/Until; ordering is always UpdatedAtUtc descending, then Id descending.

integer format: int32

Allowed values: 0 1 2

Date used by episode From/Until; ordering is always UpdatedAtUtc descending, then Id descending.

From

string format: date-time

Until

string format: date-time

Page

integer format: int32

PageSize

integer format: int32

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

object

Data

Database-filtered page of authorized episodes.

object

Items

Array<object>

nullable

Authorized, path-safe diagnostics for a single episode.

object

string

nullable

SourceId

string

nullable

AgentId

string

nullable

FileId

string

nullable

ObjectDisplayName

string

nullable

FileName

string

nullable

PolicyKind

integer format: int32

Allowed values: 0 1 2 3 4 5

Severity

integer format: int32

Allowed values: 1 2

State

integer format: int32

Allowed values: 0 1 2

RaisedAtUtc

string format: date-time

UpdatedAtUtc

string format: date-time

ResolvedAtUtc

string format: date-time

nullable

DiagnosticCode

string

nullable

ResolutionCode

string

nullable

ReferenceAtUtc

string format: date-time

nullable

LastObservedAtUtc

string format: date-time

nullable

CountedMinutes

number format: double

nullable

ThresholdMinutes

integer format: int32

nullable

RunId

string

nullable

OccurrenceId

string

nullable

RecoveryPointId

string

nullable

TimeZoneId

string

nullable

Calendar

Array<object>

nullable

One weekly local interval; day is ISO Monday=1 through Sunday=7. End less than start crosses midnight.

object

DayOfWeek

integer format: int32

StartMinute

integer format: int32

EndMinute

integer format: int32

RowVersion

string format: uuid

AllowedActions

Array<string>

nullable

SafeErrorCode

string

nullable

NextThresholdAtUtc

string format: date-time

nullable

TotalCount

integer format: int32

Page

integer format: int32

PageSize

integer format: int32

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": {
    "Items": [
      {
        "PolicyKind": 0,
        "Severity": 1,
        "State": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}