Skip to main content
GET
/
api
/
v1
/
actions
/
{action_id}
/
schedule
get schedule for an action
curl --request GET \
  --url https://cloud.bytebeam.io/api/v1/actions/{action_id}/schedule \
  --header 'x-bytebeam-api-key: <api-key>' \
  --header 'x-bytebeam-tenant: <api-key>'
import requests

url = "https://cloud.bytebeam.io/api/v1/actions/{action_id}/schedule"

headers = {
    "x-bytebeam-api-key": "<api-key>",
    "x-bytebeam-tenant": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'x-bytebeam-api-key': '<api-key>', 'x-bytebeam-tenant': '<api-key>'}
};

fetch('https://cloud.bytebeam.io/api/v1/actions/{action_id}/schedule', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.bytebeam.io/api/v1/actions/{action_id}/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-bytebeam-api-key: <api-key>",
    "x-bytebeam-tenant: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.bytebeam.io/api/v1/actions/{action_id}/schedule"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-bytebeam-api-key", "<api-key>")
	req.Header.Add("x-bytebeam-tenant", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://cloud.bytebeam.io/api/v1/actions/{action_id}/schedule")
  .header("x-bytebeam-api-key", "<api-key>")
  .header("x-bytebeam-tenant", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.bytebeam.io/api/v1/actions/{action_id}/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-bytebeam-api-key"] = '<api-key>'
request["x-bytebeam-tenant"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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,
  "tenant_id": "<string>",
  "release_notes": "<string>"
}

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

​
action_id
integer<int64>
required

Response

​
phases_triggered
boolean[]
required
​
next_phase_index
integer<int64>
required
​
end_timestamp
integer<int64>
required
​
retry_on_failure_until
integer<int64>
required
​
phases
object[]
required
​
status
string
required
​
id
integer<int64>
required
​
tenant_id
string
required
​
release_notes
string