Stream build logs

GET/v1/builds/{buildId}/logsStream build logs

⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️

Streams the full build log for a build as newline-delimited JSON (application/x-ndjson). Each line is a JSON object discriminated by type: log (a build output line) or terminal (end-of-stream marker with a cursor for resumption). The default is a finite dump that ends once the stream is drained; pass follow=true to keep the connection open for an in-flight build, and cursor to resume from a prior terminal cursor.

Parameters

buildIdstringpathrequired

minLength 1

followstringquery

one of "true", "false"

cursorstringquery

Responses

value

oneOf · 2 options

Option 1object

cursorstringrequired

levelstringrequired

one of "info", "error"

sourcestringrequired

one of "runner", "stdout", "stderr"

stepstring

textstringrequired

typestringrequired

const "log"

Option 2object

codestringrequired

cursornull | stringrequired

kindstringrequired

one of "end", "error"

messagestringrequired

retryablebooleanrequired

typestringrequired

const "terminal"

Example response

{
  "code": "string",
  "cursor": "string",
  "kind": "end",
  "message": "string",
  "retryable": true,
  "type": "terminal"
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

buildIdrequiredpath parameter

followquery parameter

cursorquery parameter

curl -X GET 'https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false'

const response = await fetch('https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.prisma.io/v1/builds/string/logs?cursor=string&follow=false");
using var response = await client.SendAsync(request);

{
  "code": "string",
  "cursor": "string",
  "kind": "end",
  "message": "string",
  "retryable": true,
  "type": "terminal"
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Parameters

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets