Sign in

v1

latestOpenAPI 3.0.02026-07-249372139.7 KB
Timeline

Timeline by ID

Fetch a specific timeline.

get/timeline/{TimelineID}

Path parameters

TimelineIDinteger required

ID of Timeline

Query parameters

fields[]string[]

Will only return the fields specified from this parameter, multiple uses of the parameter required for multiple fields

Response

IDinteger
Statusstring
AdHocboolean

Indicator if the timeline entry was run manually or scheduled

ChangeDetectionsinteger
Alertsinteger
Latestboolean

Latest timeline entry indicator

ExitCodeinteger
ExitMessagestring
CreatedOnstring
UpdatedOnstring nullable
ScheduledAtstring
ProcessingAtstring
RunningAtstring
FinishedAtstring
PayloadSizeBytesinteger

Maximum size is 25,000,000 for inspection to land

Expiredboolean

Example response

[
  {
    "ID": 1294715,
    "Environment": {
      "ID": 18701,
      "ServiceProviderID": 1,
      "Name": "Contoso Nation",
      "ShortName": "CN",
      "Description": "Example Description",
      "Status": 1,
      "Visible": true,
      "ExpiresOn": "2021-09-10T19:21:03.195Z",
      "KeyRotation": 90,
      "LastKeyRotation": "2021-09-10T19:21:03.195Z",
      "Website": "contoso.com",
      "CreatedOn": "2021-09-10T19:21:03.195Z",
      "UpdatedOn": "2021-09-10T19:21:03.195Z",
      "Tier": "Core"
    },
    "Launchpoint": {
      "ID": 18700,
      "Alias": "Launchpoint Name",
      "Config": "{\"AD_SERVER\":\"dfdfdfdfd\",\"SEARCH_BASE\":\"dfdfdfd\",\"TIMEOUT\":2,\"TRIMMED\":1}",
      "TotalScheduledRuns": 1,
      "TotalAdHocRuns": 3,
      "NextScheduledFor": "2021/09/10 19:21:03",
      "LastScheduledRun": "2021/09/10 19:21:03",
      "LastAdHocRun": "2021/09/10 19:21:03",
      "FreqType": "weeks",
      "FreqInterval": 2,
      "ActiveStart": "2021/09/10 19:21:03",
      "ActiveEnd": "2021/09/10 19:21:03",
      "Enabled": true,
      "Visible": true,
      "Status": "Active",
      "CreatedOn": "2021/09/10 19:21:03",
      "UpdatedOn": "2021/09/10 19:21:03",
      "EnvironmentID": 8000
    },
    "System": {
      "ID": 3454,
      "Name": "System Name",
      "Description": "This is the description",
      "Status": 1,
      "Visible": true,
      "LastVerifyTime": "2021/09/10 19:21:03",
      "CreatedOn": "2021/09/10 19:21:03",
      "CreatedBy": "Alex Weber"
    },
    "SystemDetail": {
      "ID": 295035,
      "VersionID": 26,
      "Status": 1,
      "Visible": true,
      "StartDate": "2021/09/10 19:21:03",
      "CreatedOn": "2021/09/10 19:21:03"
    },
    "Status": "Completed",
    "ChangeDetections": 3,
    "Alerts": 2,
    "CreatedOn": "2021/09/10 19:21:03",
    "UpdatedOn": "2021/09/10 19:21:03",
    "ScheduledAt": "2021/09/10 19:21:03",
    "ProcessingAt": "2021/09/10 19:21:03",
    "RunningAt": "2021/09/10 19:21:03",
    "FinishedAt": "2021/09/10 19:21:03",
    "PayloadSizeBytes": 202285
  }
]