Domains

Manage custom domains for your Stormkit environments

The Domains API allows you to add, list, and manage custom domains for your environments.

Add Domain

POST /v1/domains · endpoint

Add a custom domain to an environment.

Request Body

domain · string · required

The domain name to add (e.g., “example.org”)

Response

domainId · string

The unique identifier for the created domain

token · string

Verification token for DNS TXT record validation

Request

curl -X POST \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/domains' \
  -d '{ "domain": "example.org" }'

---

List Domains

GET /v1/domains · endpoint

Retrieve all domains attached to an environment.

Query Parameters

afterId · string

Pagination cursor for retrieving the next page of results

pageSize · string

Number of results to return (maximum: 250)

verified · string

Filter by verification status. Set to “true” to return only verified domains

Response

domains · array

Array of domain objects

Show Domain Object

id · string

Unique domain identifier

domainName · string

The domain name

verified · boolean

Whether the domain is verified (always true for self-hosted instances)

token · string

Verification token for DNS TXT record

customCert · object

Custom SSL certificate information

Show Custom Certificate

value · string

Certificate value in PEM format

key · string

Private key in PEM format

pagination · object

Show Pagination

hasNextPage · boolean

Whether more results are available

afterId · string

Cursor for the next page

Request

curl -X GET \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/domains'

---

Delete Domain

DELETE /v1/domains · endpoint

Remove a domain by its ID.

Query Parameters

id · string · required

The domain ID to delete

Response

ok · boolean

Whether the deletion was successful

Request

curl -X DELETE \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/domains?id=1501'

---

Update Custom Certificate

PUT /v1/domains/cert · endpoint

Upload a custom SSL certificate for a domain.

This endpoint is only available for Enterprise customers.

Request Body

domainId · string · required

The ID of the domain

certKey · string · required

Private key in PEM format

certValue · string · required

Certificate value in PEM format

Response

ok · boolean

Whether the certificate was updated successfully

You can convert CRT files to PEM format using OpenSSL:

openssl x509 -in example_org.crt -out example_org.pem -outform PEM

Request

curl -X PUT \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/domains/cert' \
  -d '{
    "domainId": "2500",
    "certValue": "-----BEGIN CERTIFICATE-----\n...",
    "certKey": "-----BEGIN PRIVATE KEY-----\n..."
  }'

---

Delete Custom Certificate

DELETE /v1/domains/cert · endpoint

Remove the custom SSL certificate from a domain.

This endpoint is only available for Enterprise customers.

Query Parameters

id · string · required

The domain ID

Response

ok · boolean

Whether the certificate was deleted successfully

Request

curl -X DELETE \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/domains/cert?id=2500'