To stay updated on your favorite discussions, please create an account or log in. Then, click the Bookmark icon to subscribe and receive notifications.

Elements API Changelog

2»

Comments

  • Hubert_Szymanski
    Hubert_Szymanski W/ Staff, W/ Article Coordinator Posts: 10 W/ Staff

    Elements API: incidents updates

    Listing incidents: new fields have been added to incidents listing endpoint:

    • riskScore is numerical representation of incident's risk. It's directly linked to the riskLevel.
    • categories is a list with incident's categories that helps with classification of the incident like for example CREDENTIAL_THEFT etc.

    Commenting incidents: new endpoint has been implemented that allows to add comment to incidents. At the moment added comments are visible in EDR portal when viewing incident's details.

  • SergeH
    SergeH W/ Partner, W/ Staff, W/ Product Leadership, W/ Article Coordinator Posts: 45 W/ Product Leadership
    edited September 2023

    Endpoint Protection API: Subscriptions endpoints end of life on 11th of March 2024

    The old subscriptions endpoints are deprecated and should be replaced by the subscription endpoints in the Provisioning API. To use this API, you need to request Read-only Provisioning API credentials from WithSecure Support. Access to Provisioning API is only for partner (SOP) accounts.

    The following Endpoint Protection API subscriptions endpoints will stop working on the 11.03.2024:

    • Get company subscription details
    • Get partner subscription details
    • List company subscriptions
    • List partner subscriptions
    • Remove computers from subscription (replaced by Elements API endpoints “Update device state” or “Delete device”)

  • Milosz
    Milosz W/ Staff Posts: 17 W/ Staff

    Query EPP, EDR and Collaboration Protection (ECP) Security Events

    New Elements Security Events query endpoint has been released and is available for new and existing integrations. New endpoint allows querying Security Events generated in Endpoint Protection (EPP), Endpoint Detection and Response (EDR) and Collaboration Protection (ECP).

    Support for Collaboration Protection engines allows reading Security Events related to Microsoft Outlook, OneDrive, SharePoint and Teams from REST API. To get last 10 Collaboration Protection events with cURL run command curl -H "Authorization: Bearer <authorization token>" -d "persistenceTimestampEnd=2030-12-31T00:00:00Z&engineGroup=ecp&limit=10" https://api.connect.withsecure.com/security-events/v1/security-events. More examples can be found in endpoint documentation, Getting started guide and in Elements API Cookbook.

    Q&A

    Q: Why do you introduce new endpoint instead extending capabilities of existing one?

    A: Existing GET /security-events/v1/security-events endpoint is a legacy from early releases and cannot be easily extended to support Collaboration Protection events. The new endpoint has a more modern design and will make it easier to add new features and capabilities in the future.

    Q: Is Security Events query endpoint compatible with existing endpoint?

    A: If you're interested only with events from EPP and EDR then you won't notice any significant differences. Security Events query endpoint preserves format of response that is known from existing endpoint. If you're interested with Collaboration Protection events you need to adjust your integration and prepare it for different response - for example they don't have device properties or user name.

    Q: I'm only interested with Security Events from EPP and EDR. What I need to change after switching to new endpoint.

    A: Response for EPP and EDR engines contains same properties that are present in response from
    GET /security-events/v1/security-events. In order to get EPP and EDR events you need to make
    following changes in your integration:

    • send query parameters in request body,
    • add to request HTTP header Content-type: application/x-www-form-urlencoded,
    • add to request HTTP header Accept: application/json,
    • add parameter engineGroup=epp,edr to request body in order to receive only Security Events from EDR and EPP
    • adjust value of parameter limit - maximal allowed value is 200

    Q: What will happen with existing GET /security-events/v1/security-events endpoint.

    A: Existing endpoint will stay there, we don't have plans to remove it or deprecate it. It means that you can continue using it in your integration if you're interested only with EPP and EDR events. We will keep maintaining endpoint (bug fixes) however we will stop adding new features to it. New capabilities will be added only to Security Events query endpoint.

  • SergeH
    SergeH W/ Partner, W/ Staff, W/ Product Leadership, W/ Article Coordinator Posts: 45 W/ Product Leadership

    Elements API: Description added to both incidents and detections endpoints

    “/incidents/v1/incidents” - description of incident entered in Elements Security Center

    Property “description” contains the "incident description" that user inserts in Broad Context Detections (BCD) view under "analysis" tab. This is useful information for a reporting system or a ticketing solution

    “/incidents/v1/detections” - human-friendly description of detection

    Property “description” contains value that is visible in detections list in Elements Security Center

  • Milosz
    Milosz W/ Staff Posts: 17 W/ Staff

    Filter devices by name of operating system, public IP and Active Directory group

    New query parameters in endpoint /devices/v1/devices allows filtering EPP devices:

    • activeDirectoryGroup - filter devices by name of Active Directory group
    • osName - filter devices by name of the operating system
    • publicIpAddress - filter devices by public IP address of device

  • Milosz
    Milosz W/ Staff Posts: 17 W/ Staff

    Query missing software updates

    Missing software updates query endpoint is available in Elements API. Integration client can list missing updates for particular EPP device and filter results by category and severity. It should be used as replacement for endpoint from legacy EPP API that has been deprecated.

    Example

    To find all critical software updates for single device with curl execute following command

    curl -H "Authorization: Bearer $TOKEN" -d "deviceId=$DEVICE_ID" -d "severity=critical" https://api.connect.withsecure.com/software-updates/v1/missing-updates
    

    Replace $TOKEN with authorization token and $DEVICE_ID with device identifier that can
    be found in response from device listing.

  • SergeH
    SergeH W/ Partner, W/ Staff, W/ Product Leadership, W/ Article Coordinator Posts: 45 W/ Product Leadership

    Endpoint Protection API: List missing software updates endpoint end of life on 2nd of May 2024

    The old List missing software update endpoint is deprecated and should be replaced by the Query missing software updates endpoint in the Elements API

    The Endpoint Protection API is fully deprecated. The ability to create API keys is soon going to be removed from Elements Security Center. 

    The following endpoints have past their end of life date and should not be used anymore

    • Computers endpoints: 30th of May, 2023
    • Security events endpoints: 30th of June, 2023
    • Companies endpoints: 31st of July, 2023
    • Invitations endpoints: 3rd of November, 2023

    The following endpoints will soon be end of life, and customers should migrate as soon as possible.

    • Subscription endpoints: 11th of March, 2024
    • List missing software updates endpoint: 2nd of May,

  • Milosz
    Milosz W/ Staff Posts: 17 W/ Staff

    Query not archived EDR incidents

    Client calling Incidents endpoint can request only not archived EDR incidents by adding to query parameter archived=false. Querying only not archived incidents is highly recommended as it might have positive impact on requests speed.

    Example

    curl -H "Authorization: Bearer $TOKEN"
    https://api.connect.withsecure.com/incidents/v1/incidents?archived=false

  • maciej_antkiewicz
    maciej_antkiewicz W/ Staff, W/ Article Coordinator Posts: 2 W/ Staff
    edited November 2023

    New response actions available

    For the device operations endpoint support for the following new operations is added:

    • assign profile
    • scan for malware
    • show message
    • turn on feature: debug logging
    • collect diagnostic file

    Two new fields are introduced: metadataParameters to POST response and metadata to GET response. Both serve the same purpose - to provide operation specific information. For example, collect diagnostic file returns fileId inside these objects, field which is used to identify diagnostic file.

    For more information and request examples consult endpoints documentation:

    • https://connect.withsecure.com/api-reference/elements#post-/devices/v1/operations
    • https://connect.withsecure.com/api-reference/elements#get-/devices/v1/operations

  • Milosz
    Milosz W/ Staff Posts: 17 W/ Staff

    New capabilities of Elements API

    Security Events Query endpoint supports new filters and response properties:

    • EPP security events contain device label. Label is only present in events that were created after administrator had added label to EPP device,
    • client can filter security events by targetId - id of EPP device or e-mail address of Office 365 user,
    • client can filter security events by acknowledgement status. To select only not acknowledged events client should add acknowledged=false to request parameters,
    • acknowledged events contains acknowledgement status:
      • acknowledge date,
      • name of user that acknowledged event.

    Clients can use special value no-value in anchor parameter to get first page. It might be useful in various No-code or low-code services

  • Milosz
    Milosz W/ Staff Posts: 17 W/ Staff

    Statistics of Security Events

    Elements API client can read statistics from query endpoint. When request contains HTTP header Accept: application/vnd.withsecure.aggr+json Elements API selects all events matching query parameters, groups events by selected property. In response client receives number of items in each group.

    Example

    curl -v -X POST
    -H "Accept: application/vnd.withsecure.aggr+json" -d "count=engine"
    -d "engineGroup=epp -d "persistenceTimestampStart=2024-01-01T00:00:00Z"
    "https://api.connect.withsecure.com/security-events/v1/security-events"

    Example cURL reads statistics for EPP security events that have been created after 2024-01-01. Client uses parameter count=engine to group events by property engine.

    {
    "items" : [{
    "engine" : "manualScanning",
    "count" : 10
    }, {
    "engine" : "tamperProtection",
    "count" : 143
    }, {
    "engine" : "firewall",
    "count" : 17
    }, {
    "engine" : "deepGuard",
    "count" : 22
    } ]
    }

    Received response contains information that API found 10 events from manualScanning, 143 events from tamperProtection, 17 from firewall and 22 events from deepGuard

    Elements API Cookbook contains example statistic request implemented in Python.

  • Milosz
    Milosz W/ Staff Posts: 17 W/ Staff
    edited February 16

    Device statistics

    Elements API client can read statistics of EPP devices from query endpoint. When request contains HTTP header Accept: application/vnd.withsecure.aggr+json Elements API selects all devices matching query parameters and depending on query parameters and groups items by selected property. If client requests histogram then API return statistics for last 30 days.

    Device count

    Elements API uses value of parameter count which represents name of property that is used to group devices by. In response API return list of items where each one represents different value of property and number of devices having such value.

    Example query like curl -v -X GET
    -H "Accept: application/vnd.withsecure.aggr+json"
    "https://api.connect.withsecure.com/devices/v1/devices?count=protectionStatus"
    groups devices by property protectionStatus .

    {
    "items" : [ { "count" : 1, "protectionStatus" : "isolated" } , { "count" : 16, "protectionStatus" : "malwareIssue" }, { "count" : 4, "protectionStatus" : "notConnected" }, { "count" : 88, "protectionStatus" : "protected" }, { "count" : 11, "protectionStatus" : "subscriptionExpired" } ]
    }

    From response client can find that query found:

    • 1 device with protection status equal isolated
    • 16 devices with protection status equal malwareIssue
    • 4 devices with protection status equal notConnected
    • 88 devices with protection status equal protected
    • 11 devices with protection status equal subscriptionExpired

    Device histogram

    Elements API uses value of parameter histogram which represents name of property that is used to group devices by. In such case API return statistic for each day in last 30 day. Response contains list of items sorted in descending order where each element has format

    { "count": <number of devices>, <name of property>: <value of property>, "date": <statistic date> }
    

    Example query like curl -v -X GET
    -H "Accept: application/vnd.withsecure.aggr+json"
    "https://api.connect.withsecure.com/devices/v1/devices?histogra=protectionStatus"
    generates histogram for property protectionStatus .

    {
    "items" : [ { "count" : 1, "protectionStatus" : "isolated", "date": "2024-02-14"}, { "count" : 16, "protectionStatus" : "protected", "date": "2024-02-14"} , { "count" : 5, "protectionStatus" : "isolated", "date": "2024-02-13"}, { "count" : 12, "protectionStatus" : "protected", "date": "2024-02-13"} ]
    }

    From response client can find that:

    • on 2024-02-14:
      • there was 1 device with protection status equal isolated
      • 16 devices with protection status equal protected
    • on 2024-02-13
      • there were 5 devices with protection status equal isolated
      • 12 devices with protection status equal protected

  • glusan
    glusan W/ Staff Posts: 1 W/ Staff

    Device subscription change

    Elements API allows a solution provider to move an endpoint device from one subscription to another.

    Example query like curl -X PATCH -H "Authorization: Bearer {token}" -H "Content-Type: application/json" https:// connect.withsecure.com /devices/v1/devices -d '{"subscriptionKey": "E43V-DE4H-U2X8-87L2-438V", "targets": ["ec8a0100-d313-4896-b3cb-02188e060bf3",1c49df1a-02d9-4bc4-91db-5609b80ad709]}

    {
      "multistatus": [
        {
          "target": "ec8a0100-d313-4896-b3cb-02188e060bf3",
          "status": 200
    },
        {
          "target": "1c49df1a-02d9-4bc4-91db-5609b80ad709",
          "status": 400,
          "details": "Product transition is not allowed"
    }
      ],
      "transactionId": "0000-abcdef-1234"
    }
    

    From response client can find which devices have been successfully moved to a new subscription, and which ones failed to do that and why.