Get a build

GET/v1/builds/{buildId}Get a build

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

Returns one build with the resources it reported acting on.

Parameters

buildIdstringpathrequired

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

Responses

object

dataobjectrequired

Show child attributes

applicationTopologyContentHashnull | stringrequired

branchIdnull | stringrequired

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

branchNamestringrequired

commitShastringrequired

createdAtstringrequired

deployedUrlnull | stringrequired

errorMessagenull | stringrequired

externalLogUrlnull | stringrequired

failingStepnull | stringrequired

finishedAtnull | stringrequired

gitRepoIdnull | stringrequired

Repository the build ran against. Set only when the workspace has a live link to it; a reported repository the platform does not know stays null.

idstringrequired

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

phasenull | stringrequired

Null when nothing reported a phase; the platform never invents an observation it did not receive.

one of "queued", "build", "deploy", null

projectIdnull | stringrequired

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

resourcesarray of objectrequired

Show child attributes

Show array items

actionstringrequired

one of "created", "acted_on", "deleted"

createdAtstringrequired

resourceIdstringrequired

Prefixed id of the reported resource.

resourceTypestringrequired

one of "project", "branch", "database", "app", "deployment", "bucket", "service_key", "config_variable"

sourcestringrequired

one of "webhook", "setup", "manual", "ci", "cli"

startedAtnull | stringrequired

statestringrequired

one of "pending", "running", "succeeded", "failed", "cancelled"

Example response

{
  "data": {
    "applicationTopologyContentHash": "string",
    "branchId": "string",
    "branchName": "string",
    "commitSha": "string",
    "createdAt": "string",
    "deployedUrl": "string",
    "errorMessage": "string",
    "externalLogUrl": "string",
    "failingStep": "string",
    "finishedAt": "string",
    "gitRepoId": "string",
    "id": "string",
    "phase": "build",
    "projectId": "string",
    "resources": [
      {
        "action": "acted_on",
        "createdAt": "string",
        "resourceId": "string",
        "resourceType": "app"
      }
    ],
    "source": "ci",
    "startedAt": "string",
    "state": "cancelled"
  }
}

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

curl -X GET 'https://api.prisma.io/v1/builds/string'

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

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

import requests

response = requests.request("GET", "https://api.prisma.io/v1/builds/string")
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", 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");
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"))
    .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")
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");
using var response = await client.SendAsync(request);

{
  "data": {
    "applicationTopologyContentHash": "string",
    "branchId": "string",
    "branchName": "string",
    "commitSha": "string",
    "createdAt": "string",
    "deployedUrl": "string",
    "errorMessage": "string",
    "externalLogUrl": "string",
    "failingStep": "string",
    "finishedAt": "string",
    "gitRepoId": "string",
    "id": "string",
    "phase": "build",
    "projectId": "string",
    "resources": [
      {
        "action": "acted_on",
        "createdAt": "string",
        "resourceId": "string",
        "resourceType": "app"
      }
    ],
    "source": "ci",
    "startedAt": "string",
    "state": "cancelled"
  }
}

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