Create service

POST/v1/servicesCreate service

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

Creates a new service under the specified project. The projectId is required in the request body. The service is placed in the given region, or the project's default region if omitted (falling back to us-east-1). Returns 409 Conflict when a service already occupies the slot on the resolved branch, either by name or by logicalId; the body includes the existing service's id, name, branch, and logical id, and conflict says which attribute clashed. The name is checked first. logicalId cannot be combined with branchGitName; pass branchId instead.

Request body

application/json

object

branchGitNamenull | string

minLength 1

branchIdnull | string

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

displayNamestringrequired

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._-]*$

projectIdstringrequired

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

regionIdstring

one of "us-east-1", "us-west-1", "eu-west-3", "eu-central-1", "ap-northeast-1", "ap-southeast-1" · default "us-east-1"

Example request

{
  "branchGitName": "string",
  "branchId": "string",
  "displayName": "string",
  "logicalId": "string",
  "projectId": "string",
  "regionId": "us-east-1"
}

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

branchGitNamestringrequired

codestringrequired

const "app:already_exists"

conflictstring

Which attribute of the existing app clashed.

one of "name", "logicalId"

existingAppIdstringrequired

logicalIdnull | string

The existing app's logical id.

messagestringrequired

namestringrequired

Example response

{
  "error": {
    "branchGitName": "string",
    "code": "app:already_exists",
    "conflict": "logicalId",
    "existingAppId": "string",
    "logicalId": "string",
    "message": "string",
    "name": "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

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

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

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

import requests

response = requests.request(
    "POST",
    "https://api.prisma.io/v1/services",
    headers={"Content-Type": "application/json"},
    data='{"branchGitName":"string","branchId":"string","displayName":"string","logicalId":"string","projectId":"string","regionId":"us-east-1"}',
)
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","projectId":"string","regionId":"us-east-1"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.prisma.io/v1/services", 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");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"displayName\":\"string\",\"logicalId\":\"string\",\"projectId\":\"string\",\"regionId\":\"us-east-1\"}");
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"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"branchGitName\":\"string\",\"branchId\":\"string\",\"displayName\":\"string\",\"logicalId\":\"string\",\"projectId\":\"string\",\"regionId\":\"us-east-1\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/services")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"displayName\":\"string\",\"logicalId\":\"string\",\"projectId\":\"string\",\"regionId\":\"us-east-1\"}"
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.Post, "https://api.prisma.io/v1/services");
request.Content = new StringContent("{\"branchGitName\":\"string\",\"branchId\":\"string\",\"displayName\":\"string\",\"logicalId\":\"string\",\"projectId\":\"string\",\"regionId\":\"us-east-1\"}", 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": {
    "branchGitName": "string",
    "code": "app:already_exists",
    "conflict": "logicalId",
    "existingAppId": "string",
    "logicalId": "string",
    "message": "string",
    "name": "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

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets