A domain represents an isolated realm encapsulating entities such as clients, users, and configuration.

Manage domains via the /v1/domain endpoint.

Prerequisites:

GET /v1/domain

Gets a list of domains registered under the subscription associated with the API key.

curl -X 'GET' \
  'https://api.entrypage.io/v1/domain' \
  -H 'accept: text/plain' \
  -H 'x-api-key: your-api-key-here'
Responses

Response: 200 - OK

{
  "domain": "string"
}

Response: 401 - Unauthorized

POST /v1/domain

Registering a domain will provision DNS and configure an OAuth 2.1 server for the provided domain. Leave the request body empty to use a default subdomain (e.g., *.sandbox.entrypage.io), or provide your own domain name for a custom DNS setup.

curl -X 'POST' \
  'https://api.entrypage.io/v1/domain' \
  -H 'accept: text/plain' \
  -H 'x-api-key: your-api-key-here' \
  -d ''
Responses

Response: 201 - Created

{
  "domain": "string"
}

Response: 400 - Bad Request Response: 401 - Unauthorized

DELETE /v1/domain/{domain}

Deleting a domain is irreversible.

All applications configured within this realm will immediately stop working. All users associated with this realm will be permanently deleted. All logs tied to this realm will also be permanently removed.

curl -X 'DELETE' \
  'https://api.entrypage.io/v1/domain/your-domain-here' \
  -H 'accept: */*' \
  -H 'x-api-key: your-api-key-here'
Responses

Response: 202 - Accepted

Response: 401 - Unauthorized

API Documentation (Swagger)

The Entrypage API is hosted at api.entrypage.io, offering documentation to help you get started quickly:

Swagger UI:

Use our interactive interface to browse endpoints, understand parameters, and even make live API calls directly from your browser.

OpenAPI Specification:

Download the latest up-to-date OpenAPI Spec (formerly Swagger Spec) for full programmatic access and integration with your development tools.