Update service

PATCH/v1/services/{serviceId}Update service

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

Updates the display name, logical id, or branch of a service. logicalId cannot be combined with branchId or branchGitName in one request; move the service first, then set its logicalId.

Parameters

serviceIdstringpathrequired

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

Request body

application/json

object

branchGitNamenull | string

minLength 1

branchIdnull | string

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

displayNamestring

maxLength 256 · minLength 1

logicalIdstring

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource.

maxLength 255 · pattern ^[A-Za-z0-9][A-Za-z0-9._-]*$

Example request

{
  "branchGitName": "string",
  "branchId": "string",
  "displayName": "string",
  "logicalId": "string"
}

Responses

object

dataobjectrequired

Show child attributes

appEndpointDomainstringrequired

branchIdnull | stringrequired

createdAtstring · date-timerequired

idstringrequired

latestDeploymentIdnull | stringrequired

logicalIdnull | stringrequired

namestringrequired

projectIdstringrequired

regionobjectrequired

Show child attributes

idstringrequired

namestringrequired

typestringrequired

const "app"

urlstring · urirequired

Example response

{
  "data": {
    "appEndpointDomain": "string",
    "branchId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "id": "string",
    "latestDeploymentId": "string",
    "logicalId": "string",
    "name": "string",
    "projectId": "string",
    "region": {
      "id": "string",
      "name": "string"
    },
    "type": "app",
    "url": "https://example.com"
  }
}

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

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

serviceIdrequiredpath parameter

curl -X PATCH 'https://api.prisma.io/v1/services/string' \
  -H 'Content-Type: application/json' \
  -d '{"branchGitName":"string","branchId":"string","displayName":"string","logicalId":"string"}'

const response = await fetch('https://api.prisma.io/v1/services/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"branchGitName":"string","branchId":"string","displayName":"string","logicalId":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/services/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"displayName\":\"string\",\"logicalId\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.prisma.io/v1/services/string",
    headers={"Content-Type": "application/json"},
    data='{"branchGitName":"string","branchId":"string","displayName":"string","logicalId":"string"}',
)
print(response.json())

package main

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

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

require 'net/http'

uri = URI("https://api.prisma.io/v1/services/string")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"displayName\":\"string\",\"logicalId\":\"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.Patch, "https://api.prisma.io/v1/services/string");
request.Content = new StringContent("{\"branchGitName\":\"string\",\"branchId\":\"string\",\"displayName\":\"string\",\"logicalId\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "appEndpointDomain": "string",
    "branchId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "id": "string",
    "latestDeploymentId": "string",
    "logicalId": "string",
    "name": "string",
    "projectId": "string",
    "region": {
      "id": "string",
      "name": "string"
    },
    "type": "app",
    "url": "https://example.com"
  }
}

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

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