Skip to main content

HistoryEntryV4

agentIdstringrequired
agentVersionstringrequired

agent version. v1 migration will be git sha, v4 will be uuid

messagestringrequired

commit message for the change description

authorEmailstring
assets objectrequired
linuxExe object

linux exe asset that can be downloaded

createdstringnullable

Date the asset was created. The bin should never be updated so confirm when downloaded the lastupdated is this

checksumstringnullable

crc32 checksum

storageUrlstringnullable

gsutil uri

signedUrlstringnullable

signed url that will be generated after pulling from db

windowsExe object

windows exe asset that can be downloaded

createdstringnullable

Date the asset was created. The bin should never be updated so confirm when downloaded the lastupdated is this

checksumstringnullable

crc32 checksum

storageUrlstringnullable

gsutil uri

signedUrlstringnullable

signed url that will be generated after pulling from db

windowsMsi object

windows msi asset that can be downloaded

createdstringnullable

Date the asset was created. The bin should never be updated so confirm when downloaded the lastupdated is this

checksumstringnullable

crc32 checksum

storageUrlstringnullable

gsutil uri

signedUrlstringnullable

signed url that will be generated after pulling from db

processorstringrequired

user-defined code sha stored in git

configurationstringrequired

yaml of config for agent

coreAgentVersionstringrequired

version of the core agent exe being used

createdAtstring<date-time>
updatedAtstring<date-time>
requireFullUpdateboolean
status object
entitystringrequired
timestringrequired
typestringrequired

Possible values: [FLOW, CONTAINER, AGENT, GATEWAY]

identifierstringrequired
buildStatusstringrequired

Possible values: [PROCESSING, COMPLETED, ERROR, PENDING]

deployStatusstringrequired

Possible values: [PROCESSING, COMPLETED, ERROR, PENDING]

userUidstringrequired
idnumber
author object
idnumberrequired
roleAccessType (string)required

Possible values: [admin, reader, runner, writer, none]

emailstringrequired
saml_idstringrequired
assigned_flows object[]
  • Array [
  • idstringrequired
    namestringrequired
    environmentstringrequired
    versionstring
    docsMarkdownstring
    assigneesstring[]
  • ]
  • githubLoginstring
    application_sessions object[]
  • Array [
  • idstringrequired
    applicationstringrequired
    initiatorstringrequired
    statusstringrequired

    Possible values: [Initializing, Live, Stopped, Error, Standby, Paused, Resuming]

    initializationStatusstringrequired

    Possible values: [Preparing Session Infrastructure, Creating VM from template, Generating VM Password, Creating Network, Scheduling VM Management, Starting VM, Sending VM Hello Message, Waiting for Response, Initialization Complete]

    inputFilesstring[]required
    outputFilesstring[]nullablerequired
    startTimestringrequired
    endTimestring
    usersundefined[]
    passwordstringrequired
    domainstringrequired
    portnumberrequired
    vmNamestringrequired
    timeoutstringrequired
    vncPasswordstring
    preWarmboolean
  • ]
  • lastSeenAtstring<date-time>
    lastActiveAtstring<date-time>
    deletedAtstring<date-time>nullable
    showSidebarTourbooleanrequired
    showHomepageTourbooleanrequired
    showFilesTourbooleanrequired
    showFlowRunsTourbooleanrequired
    showFlowEditorTourbooleanrequired
    showAnalysisAppCardTourbooleanrequired
    showProcessUnitOpsTourbooleanrequired
    showGatewayTourbooleanrequired
    showHostDetailsTourbooleanrequired
    showConnectorConnectionDetailsTourbooleanrequired
    showConnectorDetailsTourbooleanrequired
    notificationPopupSettingstringrequired

    Possible values: [All, Errors, My Notifications, None]

    HistoryEntryV4
    {
    "agentId": "string",
    "agentVersion": "string",
    "message": "string",
    "authorEmail": "string",
    "assets": {
    "linuxExe": {
    "created": "string",
    "checksum": "string",
    "storageUrl": "string",
    "signedUrl": "string"
    },
    "windowsExe": {
    "created": "string",
    "checksum": "string",
    "storageUrl": "string",
    "signedUrl": "string"
    },
    "windowsMsi": {
    "created": "string",
    "checksum": "string",
    "storageUrl": "string",
    "signedUrl": "string"
    }
    },
    "processor": "string",
    "configuration": "string",
    "coreAgentVersion": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "requireFullUpdate": true,
    "status": {
    "entity": "string",
    "time": "string",
    "type": "FLOW",
    "identifier": "string",
    "buildStatus": "PROCESSING",
    "deployStatus": "PROCESSING",
    "userUid": "string"
    },
    "id": 0,
    "author": {
    "id": 0,
    "role": "admin",
    "email": "string",
    "saml_id": "string",
    "assigned_flows": [
    {
    "id": "string",
    "name": "string",
    "environment": "string",
    "version": "string",
    "docsMarkdown": "string",
    "assignees": [
    "string"
    ]
    }
    ],
    "githubLogin": "string",
    "application_sessions": [
    {
    "id": "string",
    "application": "string",
    "initiator": "string",
    "status": "Initializing",
    "initializationStatus": "Preparing Session Infrastructure",
    "inputFiles": [
    "string"
    ],
    "outputFiles": [
    "string"
    ],
    "startTime": "string",
    "endTime": "string",
    "users": [
    null
    ],
    "password": "string",
    "domain": "string",
    "port": 0,
    "vmName": "string",
    "timeout": "string",
    "vncPassword": "string",
    "preWarm": true
    }
    ],
    "lastSeenAt": "2024-07-29T15:51:28.071Z",
    "lastActiveAt": "2024-07-29T15:51:28.071Z",
    "deletedAt": "2024-07-29T15:51:28.071Z",
    "showSidebarTour": true,
    "showHomepageTour": true,
    "showFilesTour": true,
    "showFlowRunsTour": true,
    "showFlowEditorTour": true,
    "showAnalysisAppCardTour": true,
    "showProcessUnitOpsTour": true,
    "showGatewayTour": true,
    "showHostDetailsTour": true,
    "showConnectorConnectionDetailsTour": true,
    "showConnectorDetailsTour": true,
    "notificationPopupSetting": "All"
    }
    }