List custom domains for a service

GET/v1/services/{serviceId}/domainsList custom domains for a service

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

Returns all custom domains attached to any deployment of the service. Domains are aggregated across all deployments since Foundry lists per deployment.

Parameters

serviceIdstringpathrequired

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

Responses

object

dataarray of objectrequired

Show child attributes

Show array items

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

paginationobjectrequired

Show child attributes

hasMorebooleanrequired

const false

nextCursornullrequired

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"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}

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 GET 'https://api.prisma.io/v1/services/string/domains'

const response = await fetch('https://api.prisma.io/v1/services/string/domains', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/services/string/domains', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.prisma.io/v1/services/string/domains")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.prisma.io/v1/services/string/domains", nil)
	if err != nil {
		panic(err)
	}
	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, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/services/string/domains"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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("GET", false, true, uri)
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.Get, "https://api.prisma.io/v1/services/string/domains");
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"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}

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

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets