Go to CoAlias
  1. All Collections
  3. API Docs v1
Image

API Docs v1

Avatar

By Ab Advany

May 28, 2023

This documentation outlines the usage of the Coalias API, which provides operations for managing domains. The base URL for all requests is https://api.coalias.com/v1.

Authorization

All API requests require the use of a bearer token in the Authorization header. The token must be included in every API request. Example:

"Authorization": "Bearer {valid_token}"

Error Handling

All endpoints return a JSON response. In case of error, the returned object will contain a property "error_returned": true along with a specific error code and message.

Endpoints

POST /domains

Create a new domain.

Request

{
  "domain": "string"
}

Response

{
  "data_dns_correct": "boolean",
  "data_dns_ip": "string",
  "dns_verified": "boolean",
  "error_returned": "boolean",
  "message": "string",
  "success": "boolean"
}

GET /domains

Retrieve a list of all domains.

Response

{
  "message": "string",
  "success": "boolean",
  "data_domains_list": ["string"],
  "error_returned": "boolean"
}

DELETE /domains/{domain}

Delete a domain.

Request

{domain} is the name of the domain to be deleted.

Response

{
  "error_returned": "boolean",
  "message": "string",
  "success": "boolean"
}

GET /domains/{domain}

Retrieve details about a specific domain. It will also try to verify the dns and ownership again.

Request

{domain} is the name of the domain.

Response

{
  "data_dns_correct": "boolean",
  "data_dns_ip": "string",
  "data_verified": "boolean",
  "error_returned": "boolean",
  "message": "string",
  "success": "boolean"
}


IMAGE