GET
https://jmpy.me/api/v1
/
domains
/
check-domain
/
{domain}
Check Branded Available
curl --request GET \
  --url https://jmpy.me/api/v1/domains/check-domain/{domain} \
  --header 'Authorization: Bearer <token>'
{
  "available": true,
  "message": "<string>"
}
Check if a branded domain (e.g., go.mycompany.com) is available to be registered on Jmpy.me.

Path Parameters

domain
string
required
The domain to check. Only alphanumeric characters, dashes, and dots are allowed.

Response

available
boolean
Whether the domain is available.
message
string
Status message.

Request Examples

curl -X GET "https://jmpy.me/api/v1/domains/check-domain/go.acme.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Examples

{
  "success": true,
  "data": {
    "domain": "go.acme.com",
    "available": true,
    "message": "Domain is available"
  }
}

Use Cases

Check availability before attempting to register access to a domain.
async function registerDomain(domain) {
  // 1. Check availability first
  const checkResponse = await fetch(
    `https://jmpy.me/api/v1/domains/check-domain/${domain}`,
    { headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
  );
  const checkResult = await checkResponse.json();

  if (!checkResult.data.available) {
    throw new Error(`Domain ${domain} is not available`);
  }

  // 2. Register if available
  const createResponse = await fetch(
    'https://jmpy.me/api/v1/domains/branded',
    {
      method: 'POST',
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({ domain })
    }
  );
  
  return await createResponse.json();
}