✔️ Fetch all actions

GET {{host}}{{api-path}}/actions

To fetch all the actions following is passed to the headers:

x-bytebeam-tenant: <tenant>
x-bytebeam-api-key: <your api-key>

The api also takes optional query params page,limit and incomplete where limit per page for pagination and incomplete if set to true can be used to filter out incomplete actions.

The response is an array of objects which returns all the actions. Every action response has keys:

  • :action_id
  • :user_name
  • :type
  • :statuses
  • :created_at
  • :download_url
  • :file_name
  • :is_deactivated .

Below is an example of response body:

{
    "actions": [
        {
            "action_id": 3653433,
            "user_name": "Jim",
            "type": "update_config",
            "statuses": {
                "Queued": 1
            },
            "statuses_phased": {
                "-1": {
                    "Queued": 1
                }
            },
            "created_at": "2024-05-10T10:44:48Z",
            "payload_type": "json"
        },
        {
            "action_id": 3652467,
            "user_name": "John Doe",
            "type": "update_firmware",
            "statuses": {
                "Queued": 1
            },
            "statuses_phased": {
                "-1": {
                    "Queued": 1
                }
            },
            "created_at": "2024-05-09T11:26:26Z",
            "payload_type": "file"
        }]
}

HEADERS

KeyDatatypeRequiredDescription
x-bytebeam-tenantstring
x-bytebeam-api-keystring

RESPONSES

status: OK

{&quot;actions&quot;:[{&quot;action_id&quot;:3653433,&quot;user_name&quot;:&quot;Jim&quot;,&quot;type&quot;:&quot;update_config&quot;,&quot;statuses&quot;:{&quot;Queued&quot;:1},&quot;statuses_phased&quot;:{&quot;-1&quot;:{&quot;Queued&quot;:1}},&quot;created_at&quot;:&quot;2024-05-10T10:44:48Z&quot;,&quot;payload_type&quot;:&quot;json&quot;},{&quot;action_id&quot;:3652467,&quot;user_name&quot;:&quot;John Doe&quot;,&quot;type&quot;:&quot;update_firmware&quot;,&quot;statuses&quot;:{&quot;Queued&quot;:1},&quot;statuses_phased&quot;:{&quot;-1&quot;:{&quot;Queued&quot;:1}},&quot;created_at&quot;:&quot;2024-05-09T11:26:26Z&quot;,&quot;payload_type&quot;:&quot;file&quot;}]}