GET
/
api
/
v1
/
actions
/
{id}
curl --request GET \
  --url https://cloud.bytebeam.io/api/v1/actions/{id} \
  --header 'x-bytebeam-api-key: <api-key>' \
  --header 'x-bytebeam-tenant: <api-key>'
{
  "schedule": {
    "phases_triggered": [
      true
    ],
    "next_phase_index": 123,
    "end_timestamp": 123,
    "retry_on_failure_until": 123,
    "phases": [
      {
        "name": "<string>",
        "trigger_on": {},
        "info": {}
      }
    ],
    "status": "<string>",
    "id": 123,
    "release_notes": "<string>",
    "tenant_id": "<string>"
  },
  "payload_type": "json",
  "type": "<string>",
  "user_email": "<string>",
  "action_id": 123,
  "user_name": "<string>",
  "created_at": {},
  "statuses": {},
  "statuses_phased": {}
}

Authorizations

​
x-bytebeam-api-key
string
header
required

API key required to authenticate requests.

​
x-bytebeam-tenant
string
header
required

Tenant(Project) name required to identify the project.

Path Parameters

​
id
integer
required

Response

200
application/json
​
payload_type
enum<string>
required
Available options:
json,
none,
text,
file
​
type
string
required
​
user_email
string
required
​
action_id
integer
required
​
user_name
string
required
​
created_at
object
required
​
statuses
object
required
​
statuses_phased
object
required
​
schedule
object
Trigger an action on a bunch of devices.Get params for an action