Domain Endpoints

GET /domains

List all available domains.

Parameters

Name	Type	Location	Required	Description
limit	string	query	No	Maximum number of domains to return. The max and default is 50. (if you need a non-paginated list, set this to -1)
offset	string	query	No	Offset into the list of returned domains. (Ignored when limit is -1)

Example Requests

cURL

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/domains

JS Fetch

fetch('https://alekeagle.me/api/domains', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • List<Domain>
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

GET /domains/:id

Get a domain by its ID.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	Domain ID

Example Requests

cURL

curl -X GET \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/domains/alekeagle.me

JS Fetch

fetch('https://alekeagle.me/api/domains/alekeagle.me', {
  method: 'GET',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • Domain
• 401 Unauthorized
  • InvalidSession
• 403 Forbidden
  • Banned
• 404 Not Found
  • InvalidDomain
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal
• 503 Service Unavailable
  • ServiceUnavailable

POST /domains

Create a new domain.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_DOMAINS scope.

Parameters

Name	Type	Location	Required	Description
id	string	body	Yes	Domain Name (example.com)
subdomains	boolean	body	No	Allow subdomains (default: false)

Example Requests

cURL

curl -X POST \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '{"id": "example.com", "subdomains": true}' \
https://alekeagle.me/api/domains

JS Fetch

fetch('https://alekeagle.me/api/domains', {
  method: 'POST',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ id: 'example.com', subdomains: true }),
});

Responses

• 201 Created
  • Domain
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
  • EndpointRequiresSecondFactor
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 409 Conflict
  • DomainExists
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal

PUT /domains/:id/subdomains

Allow subdomains on a domain.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_DOMAINS scope.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	Domain Name (example.com)

Example Requests

cURL

curl -X PUT \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/domains/example.com/subdomains

JS Fetch

fetch('https://alekeagle.me/api/domains/example.com/subdomains', {
  method: 'PUT',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • Domain
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
  • EndpointRequiresSecondFactor
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidDomain
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal

DELETE /domains/:id/subdomains

Disallow subdomains on a domain.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_DOMAINS scope.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	Domain Name (example.com)

Example Requests

cURL

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/domains/example.com/subdomains

JS Fetch

fetch('https://alekeagle.me/api/domains/example.com/subdomains', {
  method: 'DELETE',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • Domain
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
  • EndpointRequiresSecondFactor
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidDomain
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal

DELETE /domains/:id

Delete a domain. All users using this domain will have their domains reset to the default domain.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_DOMAINS scope.

Parameters

Name	Type	Location	Required	Description
id	string	path	Yes	Domain Name (example.com)

Example Requests

cURL

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
https://alekeagle.me/api/domains/example.com

JS Fetch

fetch('https://alekeagle.me/api/domains/example.com', {
  method: 'DELETE',
  headers: {
    Authorization:
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
  },
});

Responses

• 200 OK
  • DeleteDomain
• 401 Unauthorized
  • InvalidSession
  • EndpointRequiresSecondFactor
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidDomain
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal

DELETE /domains

Delete multiple domains. All users using these domains will have their domains reset to the default domain.

Non-Public Endpoint

This endpoint is not public and requires authentication of a user with staff permissions.

Scoped Session

Requests to this endpoint using a scoped session require the session to have the STAFF_MODIFY_DOMAINS scope.

Parameters

Name	Type	Location	Required	Description
ids	string[]	body	Yes	Domains to be deleted

Example Requests

cURL

curl -X DELETE \
-H "Authorization: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q" \
-H "Content-Type: application/json" \
-d '["example.com", "example.org"]' \
https://alekeagle.me/api/domains

JS Fetch

fetch('https://alekaegle.me/api/domains', {
  method: 'DELETE',
  headers: {
    'Authorization':
      'eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGhlIGV4YW1wbGUgdG9rZW4gZm9yIGRvY3MuYWxla2VhZ2xlLm1lIiwic3ViIjoiMTY0NzAxNTAyODYyNiIsImlhdCI6MTY4NzA2NzYxNCwiZXhwIjoyMDAyNjQzNjE0fQ.qAwhjhtGT56iAI52EsdVYcaTjmLPeR51TALkJ1CwRlfyDHwrsOTzAe8Y3za_tJqkvSaohwQq4cD7lZbTzMSw8Q',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(['example.com', 'example.org']),
});

Responses

• 200 OK
  • DeleteDomains
• 400 Bad Request
  • MissingFields
• 401 Unauthorized
  • InvalidSession
  • EndpointRequiresSecondFactor
• 403 Forbidden
  • Banned
  • InsufficientPermissions
• 404 Not Found
  • InvalidDomain
• 429 Too Many Requests
  • RateLimited
• 500 Internal Server Error
  • Internal