Get a custom domain

GET/v1/domains/{domainId}Get a custom domain

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

Returns details for a custom domain by id. Authorization is derived from the parent compute service's workspace.

Parameters

domainIdstringpathrequired

pattern ^(dom_)?[A-Za-z0-9]+$

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

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

domainIdrequiredpath parameter

curl -X GET 'https://api.prisma.io/v1/domains/string'

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

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

import requests

response = requests.request("GET", "https://api.prisma.io/v1/domains/string")
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/domains/string", 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/domains/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/domains/string"))
    .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/domains/string")
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/domains/string");
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"
  }
}

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