Report a resource a build acted on

PUT/v1/builds/{buildId}/resources/{resourceType}/{resourceId}Report a resource a build acted on

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

Records that the build created, acted on, or deleted a platform resource — the provenance a deploy run leaves behind. Idempotent: re-reporting the same resource updates the row rather than adding one, and never weakens the recorded action. The resource must belong to the caller's workspace, and must still be findable: a soft-deleted resource can be reported, but project, database, service_key and config_variable leave no row behind, so a build that deletes one must report it before deleting it. Reporting a deployment as created also attaches the deployment to the build and records the app it deployed into, both in the same transaction, because a deployment relates its build to that app whether or not the reporter says so.

Parameters

buildIdstringpathrequired

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

resourceTypestringpathrequired

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

resourceIdstringpathrequired

maxLength 200 · minLength 1

Request body

application/json

object

actionstringrequired

The strongest effect the build had on the resource. Re-reporting is safe: a weaker action never overwrites a stronger one, so `created` survives a later `acted_on`.

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

Example request

{
  "action": "acted_on"
}

Responses

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

resourceTyperequiredpath parameter

resourceIdrequiredpath parameter

curl -X PUT 'https://api.prisma.io/v1/builds/string/resources/app/string' \
  -H 'Content-Type: application/json' \
  -d '{"action":"acted_on"}'

const response = await fetch('https://api.prisma.io/v1/builds/string/resources/app/string', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"action":"acted_on"}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/builds/string/resources/app/string', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"action\":\"acted_on\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "https://api.prisma.io/v1/builds/string/resources/app/string",
    headers={"Content-Type": "application/json"},
    data='{"action":"acted_on"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"action":"acted_on"}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "https://api.prisma.io/v1/builds/string/resources/app/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/resources/app/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"action\":\"acted_on\"}");
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/resources/app/string"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"action\":\"acted_on\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/builds/string/resources/app/string")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"action\":\"acted_on\"}"
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.Put, "https://api.prisma.io/v1/builds/string/resources/app/string");
request.Content = new StringContent("{\"action\":\"acted_on\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

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