FROM CHAOS TO COMPLIANCE

This Wednesday | 12 PM EDT / 4 PM CEST

Homepage 5 API Documentation 5 Querying Extended Data

Querying Extended Data

NOTE: We recommend using PSAction1 PowerShell module for substantially simplified API scripting experience.

Action1 API enables you to customize some of your GET operations in order to receive extended information on top of the fields that your queries return by default. For example, in addition to endpoint details, you can obtain a patching status of your managed endpoints; or get comprehensive information about all package versions and their configuration details. Please note that enriched queries are typically longer to process.

Understanding FIELDS Parameter

An optional parameter fields is introduced to control the response data returned by Action1 API. The fields parameter should be added to your query if you want to retrieve additional details that remain concealed otherwise.

For example, https://app.action1.com/api/3.0/endpoints/managed/{organization_id}?fields=* query will return information about missing updates in addition to endpoint details.

Parameter value

Fields=*

Fields=#

Fields=

Fields=field_name

With UTF-8 encoding

Fields=%2A

Fields=%23

Fields=

Fields=field_name

Description

Returns data for all fields, including additional fields such as missing_critical_updates.

Returns default fields only. The parameter can be omitted.

Returns one or more fields that you specify in addition to default fields. For example, fields=versions.

Supported Endpoints

Currently, the following endpoints can return extended data for your GET requests:

Endpoints

endpoints/managed/{organization_id}

endpoints/managed/{organization_id}/{id}

endpoints/groups/{organization_id}/{id}/contents

packages/all

packages/all/{package_id}

packages/{organization_id}/{package_id}

updates/all

updates/{organization_id}

Additional fields

missing_critical_updates

missing_other_updates

versions

outdated_endpoints

Description

Displays the number of missing critical updates and other missing updates on the endpoints in your organization.

Enables you to see information about app package versions stored in the Action1 App Store and learn about their deployment configuration.

Enables you to see the number of endpoints missing an update.

Trying It Out

Try sending requests to the same endpoint with and without fields=* to see the difference in response data. For example:

GET /packages/all

 

Request:

curl -XGET -H "Authorization: Bearer JWT-TOKEN" https://app.action1.com/api/3.0/packages/all
 

Response:

{
   "id": "1",
   "type": "ResultPage",
   "name": "",
   "self": "https://app.action1.com/api/3.0/packages/all?from=0&limit=50",
   "items": [
      {
          "id": "Igor_Pavlov_7_Zip_1570578162075_builtin",
          "type": "Package",
          "self": "https://app.action1.com/api/3.0/packages/all/Igor_Pavlov_7_Zip_1570578162075_builtin",
          "builtin": "yes",
          "name": "7-Zip",
          "classification": "Application",
          "internal_notes": "Download: https://www.7-zip.org/download.html",
          "status": "Published",
          "description": "MSI installer of 7-Zip",
          "vendor": "Igor Pavlov",
          "update_type": "App"
       }
       {}
       {}
    ]
    "total_items": "49",
    "limit": "50",
    "next_page": "",
    "prev_page": ""
}

GET packages/all?fields=*

 

Request:

curl -XGET -H "Authorization: Bearer JWT-TOKEN" https://app.action1.com/api/3.0/packages/all?fields=%2A

 

Response:

{
   "id": "1",
   "type": "ResultPage",
   "name": "",
   "self": "https://app.action1.com/api/3.0/packages/all?fields=%2A&from=0&limit=50",
   "items": [
      {
          "id": "Igor_Pavlov_7_Zip_1570578162075_builtin",
          "type": "Package",
          "self": "https://app.action1.com/api/3.0/packages/all/Igor_Pavlov_7_Zip_1570578162075_builtin",
          "builtin": "yes",
          "name": "7-Zip",
          "classification": "Application",
          "internal_notes": "Download: https://www.7-zip.org/download.html",
          "status": "Published",
          "description": "MSI installer of 7-Zip",
          "vendor": "Igor Pavlov",
          "update_type": "App",
          "versions":  [
             {
                "id": "21.07.00.0_1640795090369",
                "type": "Version",
                "self": "https://app.action1.com/api/3.0/packages/all/Igor_Pavlov_7_Zip_1570578162075_builtin/versions/21.07.00.0_1640795090369",
                "version": "21.07.00.0",
                "app_name_match": "^(7-Zip)( \\(x64( edition)?\\))?$",
                "os": ["Windows Vista", "Windows 7", "Windows 8", "Windows 8.1", "Windows 10", "Windows Server 2008 R2", "Windows Server 2012", "Windows Server 2012 R2", "Windows Server 2016"],
                "reboot_exit_codes": "1641,3010",
                "status": "Published",
                "security_severity": "None",
                "install_type": "msi",
                "silent_uninstall_switches": "/S",
                "binary_id": {...}
                "release_date": "2021-12-26",
                "EULA_text": "To get EULA, request...",
                "additional_actions": [...],
                "notes": "- 7-Zip now can extract...",
                "file_name": {...},
                "success_exit_codes": "0",
                "approval_status": "New",
                "EULA_accepted": "no"
             },
             {...},
             {...}
          ]
      },
      {...},
      {...}
    ]
    "total_items": "49",
    "limit": "50",
    "next_page": "",
    "prev_page": ""
}