Create a custom domain

POST/v1/services/{serviceId}/domainsCreate a custom domain

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

Registers a custom hostname for the service. The hostname must CNAME to the regional switchboard target before DNS verification can succeed. Returns 429 if the service has reached its domain quota (default: 3).

Parameters

serviceIdstringpathrequired

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

Request body

application/json

object

hostnamestringrequired

maxLength 253 · minLength 1 · pattern ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*[a-z]{2,}$

Example request

{
  "hostname": "string"
}

Responses

object

dataobjectrequired

Show child attributes

appIdstringrequired

certExpiresAtnull | string · date-timerequired

computeServiceIdstringrequired

Deprecated: use `appId` instead.

createdAtstring · date-timerequired

dnsRecordsarray of objectrequired

Show child attributes

Show array items

namestringrequired

ttlnull | numberrequired

typestringrequired

const "CNAME"

valuestringrequired

failureCategorynull | stringrequired

one of "dns", "acme", "storage", "unknown", null

failureReasonnull | stringrequired

foundryStatusstringrequired

hostnamestringrequired

idstringrequired

statusstringrequired

one of "pending_dns", "verifying", "verified_routing_blocked", "provisioning_tls", "active", "failed", "removing"

typestringrequired

const "custom-domain"

updatedAtstring · date-timerequired

urlstring · urirequired

Example response

{
  "data": {
    "appId": "string",
    "certExpiresAt": "2026-06-09T00:00:00Z",
    "computeServiceId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "dnsRecords": [
      {
        "name": "string",
        "ttl": 0,
        "type": "CNAME",
        "value": "string"
      }
    ],
    "failureCategory": "acme",
    "failureReason": "string",
    "foundryStatus": "string",
    "hostname": "string",
    "id": "string",
    "status": "active",
    "type": "custom-domain",
    "updatedAt": "2026-06-09T00:00:00Z",
    "url": "https://example.com"
  }
}

object

dataobjectrequired

Show child attributes

appIdstringrequired

certExpiresAtnull | string · date-timerequired

computeServiceIdstringrequired

Deprecated: use `appId` instead.

createdAtstring · date-timerequired

dnsRecordsarray of objectrequired

Show child attributes

Show array items

namestringrequired

ttlnull | numberrequired

typestringrequired

const "CNAME"

valuestringrequired

failureCategorynull | stringrequired

one of "dns", "acme", "storage", "unknown", null

failureReasonnull | stringrequired

foundryStatusstringrequired

hostnamestringrequired

idstringrequired

statusstringrequired

one of "pending_dns", "verifying", "verified_routing_blocked", "provisioning_tls", "active", "failed", "removing"

typestringrequired

const "custom-domain"

updatedAtstring · date-timerequired

urlstring · urirequired

Example response

{
  "data": {
    "appId": "string",
    "certExpiresAt": "2026-06-09T00:00:00Z",
    "computeServiceId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "dnsRecords": [
      {
        "name": "string",
        "ttl": 0,
        "type": "CNAME",
        "value": "string"
      }
    ],
    "failureCategory": "acme",
    "failureReason": "string",
    "foundryStatus": "string",
    "hostname": "string",
    "id": "string",
    "status": "active",
    "type": "custom-domain",
    "updatedAt": "2026-06-09T00:00:00Z",
    "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"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

serviceIdrequiredpath parameter

curl -X POST 'https://api.prisma.io/v1/services/string/domains' \
  -H 'Content-Type: application/json' \
  -d '{"hostname":"string"}'

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

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

import requests

response = requests.request(
    "POST",
    "https://api.prisma.io/v1/services/string/domains",
    headers={"Content-Type": "application/json"},
    data='{"hostname":"string"}',
)
print(response.json())

package main

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

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

require 'net/http'

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

{
  "data": {
    "appId": "string",
    "certExpiresAt": "2026-06-09T00:00:00Z",
    "computeServiceId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "dnsRecords": [
      {
        "name": "string",
        "ttl": 0,
        "type": "CNAME",
        "value": "string"
      }
    ],
    "failureCategory": "acme",
    "failureReason": "string",
    "foundryStatus": "string",
    "hostname": "string",
    "id": "string",
    "status": "active",
    "type": "custom-domain",
    "updatedAt": "2026-06-09T00:00:00Z",
    "url": "https://example.com"
  }
}

{
  "data": {
    "appId": "string",
    "certExpiresAt": "2026-06-09T00:00:00Z",
    "computeServiceId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "dnsRecords": [
      {
        "name": "string",
        "ttl": 0,
        "type": "CNAME",
        "value": "string"
      }
    ],
    "failureCategory": "acme",
    "failureReason": "string",
    "foundryStatus": "string",
    "hostname": "string",
    "id": "string",
    "status": "active",
    "type": "custom-domain",
    "updatedAt": "2026-06-09T00:00:00Z",
    "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"
  }
}

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