Get deployment logs

GET/v1/deployments/{deploymentId}/logsGet deployment logs

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

Returns log output for the specified deployment. Each record is a JSON object with type: "log" (log text + byte metadata) or type: "terminal" (end-of-page signal with a resume cursor). A plain GET responds with newline-delimited JSON (application/x-ndjson): it drains the requested window (tail, from_start, or cursor), ends with a terminal record carrying the cursor for the next page, and closes. Send an Upgrade: websocket header to follow the log live instead; a live segment ends after 10 minutes with the same terminal/cursor mechanism.

Parameters

deploymentIdstringpathrequired

pattern ^(cpv_)?([cC][^\s-]{8,}|[a-z0-9]+)$

tailintegerquery

maximum 10000 · minimum 1

from_startstringquery

one of "true", "false"

cursorstringquery

pattern ^\d+$

Responses

value

oneOf · 2 options

Option 1object

byteEndintegerrequired

byteStartintegerrequired

textstringrequired

typestringrequired

const "log"

Option 2object

codestringrequired

cursornull | stringrequired

detailsobject

kindstringrequired

one of "end", "error"

messagestringrequired

retryablebooleanrequired

typestringrequired

const "terminal"

Example response

{
  "byteEnd": 0,
  "byteStart": 0,
  "text": "string",
  "type": "log"
}

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"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

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

Examples

deploymentIdrequiredpath parameter

tailquery parameter

from_startquery parameter

cursorquery parameter

curl -X GET 'https://api.prisma.io/v1/deployments/string/logs?cursor=string&from_start=false&tail=0'

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

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

import requests

response = requests.request("GET", "https://api.prisma.io/v1/deployments/string/logs?cursor=string&from_start=false&tail=0")
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/deployments/string/logs?cursor=string&from_start=false&tail=0", 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/deployments/string/logs?cursor=string&from_start=false&tail=0");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/deployments/string/logs?cursor=string&from_start=false&tail=0"))
    .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/deployments/string/logs?cursor=string&from_start=false&tail=0")
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/deployments/string/logs?cursor=string&from_start=false&tail=0");
using var response = await client.SendAsync(request);

(no response body — HTTP 101)

{
  "byteEnd": 0,
  "byteStart": 0,
  "text": "string",
  "type": "log"
}

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

{
  "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