Replace branch topology

PUT/v1/projects/{projectId}/branches/{branchId}/application-topologyReplace branch topology

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

Atomically replaces the entire topology for a branch. Composer calls this after Load, before the apply. On error, Composer warns and continues — the previous topology is preserved.

Parameters

projectIdstringpathrequired

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

branchIdstringpathrequired

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

Request body

application/json

object

contentHashstring

edgesarray of objectrequired

Show child attributes

Show array items

familystringrequired

one of "communication", "data"

fromobjectrequired

Show child attributes

directionstringrequired

one of "in", "out"

logicalIdstringrequired

minLength 1

namestringrequired

minLength 1

stylestring

toobjectrequired

Show child attributes

directionstringrequired

one of "in", "out"

logicalIdstringrequired

minLength 1

namestringrequired

minLength 1

nodesarray of objectrequired

Show child attributes

Show array items

kindstringrequired

one of "module", "service", "resource"

logicalIdstringrequired

minLength 1

parentLogicalIdnull | stringrequired

minLength 1

typestring

portsarray of objectrequired

Show child attributes

Show array items

contractHashstring

contractKindstring

directionstringrequired

one of "in", "out"

logicalIdstringrequired

minLength 1

namestringrequired

minLength 1

Example request

{
  "contentHash": "string",
  "edges": [
    {
      "family": "communication",
      "from": {
        "direction": "in",
        "logicalId": "string",
        "name": "string"
      },
      "style": "string",
      "to": {
        "direction": "in",
        "logicalId": "string",
        "name": "string"
      }
    }
  ],
  "nodes": [
    {
      "kind": "module",
      "logicalId": "string",
      "parentLogicalId": "string",
      "type": "string"
    }
  ],
  "ports": [
    {
      "contractHash": "string",
      "contractKind": "string",
      "direction": "in",
      "logicalId": "string",
      "name": "string"
    }
  ]
}

Responses

object

dataobjectrequired

Show child attributes

contentHashstring

edgesarray of objectrequired

Show child attributes

Show array items

familystringrequired

one of "communication", "data"

fromobjectrequired

Show child attributes

directionstringrequired

one of "in", "out"

logicalIdstringrequired

minLength 1

namestringrequired

minLength 1

stylestring

toobjectrequired

Show child attributes

directionstringrequired

one of "in", "out"

logicalIdstringrequired

minLength 1

namestringrequired

minLength 1

nodesarray of objectrequired

Show child attributes

Show array items

kindstringrequired

one of "module", "service", "resource"

logicalIdstringrequired

minLength 1

parentLogicalIdnull | stringrequired

minLength 1

typestring

portsarray of objectrequired

Show child attributes

Show array items

contractHashstring

contractKindstring

directionstringrequired

one of "in", "out"

logicalIdstringrequired

minLength 1

namestringrequired

minLength 1

writtenAtstring · date-time

Example response

{
  "data": {
    "contentHash": "string",
    "edges": [
      {
        "family": "communication",
        "from": {
          "direction": "in",
          "logicalId": "string",
          "name": "string"
        },
        "style": "string",
        "to": {
          "direction": "in",
          "logicalId": "string",
          "name": "string"
        }
      }
    ],
    "nodes": [
      {
        "kind": "module",
        "logicalId": "string",
        "parentLogicalId": "string",
        "type": "string"
      }
    ],
    "ports": [
      {
        "contractHash": "string",
        "contractKind": "string",
        "direction": "in",
        "logicalId": "string",
        "name": "string"
      }
    ],
    "writtenAt": "2026-06-09T00:00:00Z"
  }
}

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

projectIdrequiredpath parameter

branchIdrequiredpath parameter

curl -X PUT 'https://api.prisma.io/v1/projects/string/branches/string/application-topology' \
  -H 'Content-Type: application/json' \
  -d '{"contentHash":"string","edges":[{"family":"communication","from":{"direction":"in","logicalId":"string","name":"string"},"style":"string","to":{"direction":"in","logicalId":"string","name":"string"}}],"nodes":[{"kind":"module","logicalId":"string","parentLogicalId":"string","type":"string"}],"ports":[{"contractHash":"string","contractKind":"string","direction":"in","logicalId":"string","name":"string"}]}'

const response = await fetch('https://api.prisma.io/v1/projects/string/branches/string/application-topology', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"contentHash":"string","edges":[{"family":"communication","from":{"direction":"in","logicalId":"string","name":"string"},"style":"string","to":{"direction":"in","logicalId":"string","name":"string"}}],"nodes":[{"kind":"module","logicalId":"string","parentLogicalId":"string","type":"string"}],"ports":[{"contractHash":"string","contractKind":"string","direction":"in","logicalId":"string","name":"string"}]}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/projects/string/branches/string/application-topology', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"contentHash\":\"string\",\"edges\":[{\"family\":\"communication\",\"from\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"},\"style\":\"string\",\"to\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}}],\"nodes\":[{\"kind\":\"module\",\"logicalId\":\"string\",\"parentLogicalId\":\"string\",\"type\":\"string\"}],\"ports\":[{\"contractHash\":\"string\",\"contractKind\":\"string\",\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "https://api.prisma.io/v1/projects/string/branches/string/application-topology",
    headers={"Content-Type": "application/json"},
    data='{"contentHash":"string","edges":[{"family":"communication","from":{"direction":"in","logicalId":"string","name":"string"},"style":"string","to":{"direction":"in","logicalId":"string","name":"string"}}],"nodes":[{"kind":"module","logicalId":"string","parentLogicalId":"string","type":"string"}],"ports":[{"contractHash":"string","contractKind":"string","direction":"in","logicalId":"string","name":"string"}]}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"contentHash":"string","edges":[{"family":"communication","from":{"direction":"in","logicalId":"string","name":"string"},"style":"string","to":{"direction":"in","logicalId":"string","name":"string"}}],"nodes":[{"kind":"module","logicalId":"string","parentLogicalId":"string","type":"string"}],"ports":[{"contractHash":"string","contractKind":"string","direction":"in","logicalId":"string","name":"string"}]}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "https://api.prisma.io/v1/projects/string/branches/string/application-topology", 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/projects/string/branches/string/application-topology");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"contentHash\":\"string\",\"edges\":[{\"family\":\"communication\",\"from\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"},\"style\":\"string\",\"to\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}}],\"nodes\":[{\"kind\":\"module\",\"logicalId\":\"string\",\"parentLogicalId\":\"string\",\"type\":\"string\"}],\"ports\":[{\"contractHash\":\"string\",\"contractKind\":\"string\",\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}]}");
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/projects/string/branches/string/application-topology"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"contentHash\":\"string\",\"edges\":[{\"family\":\"communication\",\"from\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"},\"style\":\"string\",\"to\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}}],\"nodes\":[{\"kind\":\"module\",\"logicalId\":\"string\",\"parentLogicalId\":\"string\",\"type\":\"string\"}],\"ports\":[{\"contractHash\":\"string\",\"contractKind\":\"string\",\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/projects/string/branches/string/application-topology")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"contentHash\":\"string\",\"edges\":[{\"family\":\"communication\",\"from\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"},\"style\":\"string\",\"to\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}}],\"nodes\":[{\"kind\":\"module\",\"logicalId\":\"string\",\"parentLogicalId\":\"string\",\"type\":\"string\"}],\"ports\":[{\"contractHash\":\"string\",\"contractKind\":\"string\",\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}]}"
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/projects/string/branches/string/application-topology");
request.Content = new StringContent("{\"contentHash\":\"string\",\"edges\":[{\"family\":\"communication\",\"from\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"},\"style\":\"string\",\"to\":{\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}}],\"nodes\":[{\"kind\":\"module\",\"logicalId\":\"string\",\"parentLogicalId\":\"string\",\"type\":\"string\"}],\"ports\":[{\"contractHash\":\"string\",\"contractKind\":\"string\",\"direction\":\"in\",\"logicalId\":\"string\",\"name\":\"string\"}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "contentHash": "string",
    "edges": [
      {
        "family": "communication",
        "from": {
          "direction": "in",
          "logicalId": "string",
          "name": "string"
        },
        "style": "string",
        "to": {
          "direction": "in",
          "logicalId": "string",
          "name": "string"
        }
      }
    ],
    "nodes": [
      {
        "kind": "module",
        "logicalId": "string",
        "parentLogicalId": "string",
        "type": "string"
      }
    ],
    "ports": [
      {
        "contractHash": "string",
        "contractKind": "string",
        "direction": "in",
        "logicalId": "string",
        "name": "string"
      }
    ],
    "writtenAt": "2026-06-09T00:00:00Z"
  }
}

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