Register

Preview
POST
https://api.senditly.ai/v1/domains
Register a domain
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Request
name
string
required
The name of the domain.
region
enum
required
The region code.
Response
name
string
required
The name of the domain.
region
enum
required
The region code.
status
enum
required
The status of the domain.
active
boolean
required
Whether the domain is active.
records
array
required
createdAt
string
required
A date string in ISO 8601 format when the domain was created.
updatedAt
string
required
A date string in ISO 8601 format when the domain was last updated.

List

Preview
GET
https://api.senditly.ai/v1/domains
List domains
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
limit
integer
optional
A limit on the number of items to return. Defaults to 10. The value must be between 1 and 100.
startingAfter
string
optional
A cursor to start the list from. Defaults to the first item.
endingBefore
string
optional
A cursor to end the list at. Defaults to the last item.
Response
items
array
required
hasMore
boolean
required
Whether there are more items to fetch.
cursor
string
optional
A cursor to start the next list from.

Count

Preview
GET
https://api.senditly.ai/v1/domains/count
Count domains
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
after
string
optional
A cursor to start the count from.
before
string
optional
A cursor to end the count at.
Response
count
integer
required
The total number of items.

Retrieve

Preview
GET
https://api.senditly.ai/v1/domains/:name
Retrieve a domain
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
name
string
required
The name of the domain.
Response
name
string
required
The name of the domain.
region
enum
required
The region code.
status
enum
required
The status of the domain.
active
boolean
required
Whether the domain is active.
records
array
required
createdAt
string
required
A date string in ISO 8601 format when the domain was created.
updatedAt
string
required
A date string in ISO 8601 format when the domain was last updated.

Unregister

Preview
DELETE
https://api.senditly.ai/v1/domains/:name
Unregister a domain
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
name
string
required
The name of the domain.
Response
name
string
required
The name of the domain.
unregisteredAt
string
required
A date string in ISO 8601 format when the domain was unregistered.

Verify

Preview
POST
https://api.senditly.ai/v1/domains/:name/verify
Verify a domain
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
name
string
required
The name of the domain.
Response
startedAt
string
required
A date string in ISO 8601 format when the domain verification was started.