Get Deployment logs

Search the Airflow component logs of an Astro Deployment. Pass at least one source (webserver logs exist only on Airflow 2, apiserver logs only on Airflow 3), and either range seconds or startDate and endDate, spanning at most 24 hours. Each request without a searchId starts a new search. To page, repeat the request with the returned searchId and a larger offset; the search keeps its original filters, so drop searchId to change them. resultCount is the search’s total matches, capped at the returned maxNumResults (at most 10000); when the two are equal, older entries may be missing, so narrow the window or add searchText. An expired searchId returns a 400; start a new search.

GET

organizations

{organizationId}

deployments

{deploymentId}

logs

Get Deployment logs

curl --request GET \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs', 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://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 2,
  "maxNumResults": 1,
  "offset": 1,
  "resultCount": 1,
  "results": [
    {
      "raw": "<string>",
      "source": "scheduler",
      "timestamp": 123
    }
  ],
  "searchId": "<string>"
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId

string

required

The ID of the Organization to which the Deployment belongs.

deploymentId

string

required

The ID of the Deployment to get logs for.

Query Parameters

sources

enum<string>[]

required

Log sources to retrieve.

Available options:

scheduler,

triggerer,

worker,

webserver,

dag-processor,

apiserver

limit

integer

default:500

Maximum number of log entries per page.

Required range: x >= 1

offset

integer

default:0

Offset for pagination.

Required range: x >= 0

range

integer

default:3600

Range of the log search in seconds.

Required range: 60 <= x <= 86400

maxNumResults

integer

default:10000

Maximum total number of results across all pages.

Required range: x >= 1

searchId

string

Search ID for paginated results.

searchText

string

Text to filter logs by.

startDate

string<date-time>

Start of time range (RFC3339). Must be used with endDate.

endDate

string<date-time>

End of time range (RFC3339). Must be used with startDate.

Response

limit

integer

required

The requested log entry limit.

Required range: x >= 1

maxNumResults

integer

required

The maximum number of results.

Required range: x >= 0

offset

integer

required

The offset of the current results page.

Required range: x >= 0

resultCount

integer

required

The number of entries the whole search matched, up to maxNumResults.

Required range: x >= 0

results

object[]

required

The log entries.

Show child attributes

searchId

string

required

The search ID for pagination.

⌘I

Get Deployment logs

curl --request GET \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs', 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://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/logs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "limit": 2,
  "maxNumResults": 1,
  "offset": 1,
  "resultCount": 1,
  "results": [
    {
      "raw": "<string>",
      "source": "scheduler",
      "timestamp": 123
    }
  ],
  "searchId": "<string>"
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}