Add a domain.
interface Request {
domain: string
}
interface Response {
domainId: string
token: string
}
# Example
curl -X POST \
-H 'Authorization: <api_key>' \
-H 'Content-Type: application/javascript' \
'https://api.stormkit.io/v1/domains' \
-d '{ "domain": "example.org" }'
{
"domainId": "18914",
"token": "AiX8xKhrGvsnwTTvT7yoxUFlTYzjn3bm"
}
Successful responses return the newly created domain id and a token to start the verification process.
Return domains attached to an environment.
interface QueryString {
afterId?: string
verified?: "true"
}
interface Response {
domains: []Domain
pagination: Pagination
}
# Example
curl -X GET \
-H 'Authorization: <api_key>' \
-H 'Content-Type: application/javascript' \
'https://api.stormkit.io/v1/domains'
{
"domains": [
{
"id": "18914",
"domainName": "exmaple.org",
"verified": false,
"token": "AiX8xKhrGvsnwTTvT7yoxUFlTYzjn3bm"
}
],
"pagination": {
"hasNextPage": false
}
}
To filter domains by verification status, you can use the verified
querystring parameter.
To paginate results, you can specify the afterId
querystring parameter. This value is returned in the first GET
request.
Delete a Domain by it's id.
interface QueryString {
id: string
}
interface Response {
ok: boolean
}
# Example
curl -X PUT \
-H 'Authorization: <api_key>' \
-H 'Content-Type: application/javascript' \
'https://api.stormkit.io/v1/domains?id=1501'
interface Domain {
id: string
domainName: string
verified: boolean
token: string
}
interface Pagination {
hasNextPage: boolean
afterId?: string
}
Property | Definition |
---|---|
id | The unique id of the domain. |
domainName | The domain name. |
verified | Whether the domain is verified or not. For self-hosted users, this is always true . |
token | A token used to create TXT record to verify a domain. |