Update a build

PATCH/v1/builds/{buildId}Update a build

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

Records progress on a build. Any holder of the workspace token may patch any field — the webhook, the CI run and Composer each report the part of a deploy they can see, and the token is the boundary. Reaching running stamps startedAt and reaching a terminal state stamps finishedAt, both only if unset, so re-reporting the same state does not move the clock. Once a build has finished, its state no longer changes: a later report updates the other fields and leaves the state as the finishing report set it.

projectId, branchId, deployedUrl and applicationTopologyContentHash can each be set once and never changed: a reporter that resolves them partway through a deploy sets them here, but a value already recorded cannot be changed and the attempt is a conflict. Sending the value already recorded is accepted and changes nothing. projectId and branchId must belong to the caller's workspace, and a branch must belong to the build's project, so a branch from another project is refused.

Parameters

buildIdstringpathrequired

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

Request body

application/json

object

applicationTopologyContentHashstring

Content hash of the application topology this run deploys, as submitted to the application-topology endpoint. A value match, never a reference: equal hashes identify the same graph. Can be set once and never changed, like `projectId`.

maxLength 200 · minLength 1

branchIdstring

Branch the build targets. Can be set once and never changed, like `projectId`.

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

deployedUrlstring · uri

Where the deployed app can be reached. Can be set once and never changed, like `projectId`.

maxLength 2000

errorMessagestring

maxLength 5000 · minLength 1

externalLogUrlstring · uri

maxLength 2000

failingStepstring

Name of the step that failed, free text — step names come from build tooling the platform cannot validate.

maxLength 500 · minLength 1

phasestring

How far the run has got.

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

projectIdstring

Project the build targets. Can be set once and never changed: a reporter that learns the project partway through a deploy may set it, but a value already recorded cannot be changed.

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

statestring

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

Example request

{
  "applicationTopologyContentHash": "string",
  "branchId": "string",
  "deployedUrl": "https://example.com",
  "errorMessage": "string",
  "externalLogUrl": "https://example.com",
  "failingStep": "string",
  "phase": "build",
  "projectId": "string",
  "state": "cancelled"
}

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]+)$

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

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 PATCH 'https://api.prisma.io/v1/builds/string' \
  -H 'Content-Type: application/json' \
  -d '{"applicationTopologyContentHash":"string","branchId":"string","deployedUrl":"https://example.com","errorMessage":"string","externalLogUrl":"https://example.com","failingStep":"string","phase":"build","projectId":"string","state":"cancelled"}'

const response = await fetch('https://api.prisma.io/v1/builds/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"applicationTopologyContentHash":"string","branchId":"string","deployedUrl":"https://example.com","errorMessage":"string","externalLogUrl":"https://example.com","failingStep":"string","phase":"build","projectId":"string","state":"cancelled"}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/builds/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"applicationTopologyContentHash\":\"string\",\"branchId\":\"string\",\"deployedUrl\":\"https://example.com\",\"errorMessage\":\"string\",\"externalLogUrl\":\"https://example.com\",\"failingStep\":\"string\",\"phase\":\"build\",\"projectId\":\"string\",\"state\":\"cancelled\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.prisma.io/v1/builds/string",
    headers={"Content-Type": "application/json"},
    data='{"applicationTopologyContentHash":"string","branchId":"string","deployedUrl":"https://example.com","errorMessage":"string","externalLogUrl":"https://example.com","failingStep":"string","phase":"build","projectId":"string","state":"cancelled"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"applicationTopologyContentHash":"string","branchId":"string","deployedUrl":"https://example.com","errorMessage":"string","externalLogUrl":"https://example.com","failingStep":"string","phase":"build","projectId":"string","state":"cancelled"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.prisma.io/v1/builds/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"applicationTopologyContentHash\":\"string\",\"branchId\":\"string\",\"deployedUrl\":\"https://example.com\",\"errorMessage\":\"string\",\"externalLogUrl\":\"https://example.com\",\"failingStep\":\"string\",\"phase\":\"build\",\"projectId\":\"string\",\"state\":\"cancelled\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/builds/string"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"applicationTopologyContentHash\":\"string\",\"branchId\":\"string\",\"deployedUrl\":\"https://example.com\",\"errorMessage\":\"string\",\"externalLogUrl\":\"https://example.com\",\"failingStep\":\"string\",\"phase\":\"build\",\"projectId\":\"string\",\"state\":\"cancelled\"}"))
    .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("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"applicationTopologyContentHash\":\"string\",\"branchId\":\"string\",\"deployedUrl\":\"https://example.com\",\"errorMessage\":\"string\",\"externalLogUrl\":\"https://example.com\",\"failingStep\":\"string\",\"phase\":\"build\",\"projectId\":\"string\",\"state\":\"cancelled\"}"
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.Patch, "https://api.prisma.io/v1/builds/string");
request.Content = new StringContent("{\"applicationTopologyContentHash\":\"string\",\"branchId\":\"string\",\"deployedUrl\":\"https://example.com\",\"errorMessage\":\"string\",\"externalLogUrl\":\"https://example.com\",\"failingStep\":\"string\",\"phase\":\"build\",\"projectId\":\"string\",\"state\":\"cancelled\"}", Encoding.UTF8, "application/json");
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",
    "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"
  }
}

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

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets