Project Domains

​

Get Project Domains

​

Authentication

​

Response

​

Example Request

curl -X GET "https://api.deployhub.online/api/projects/65f3a2b1c4d5e6f7g8h9i0j1/domains" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​

Example Response

{
  "success": true,
  "project": {
    "_id": "65f3a2b1c4d5e6f7g8h9i0j1",
    "subdomain": "my-app",
    "hascustomDomain": false,
    "plan": "free"
  }
}

​

Example Response (With Custom Domain)

{
  "success": true,
  "project": {
    "_id": "65f3a2b1c4d5e6f7g8h9i0j1",
    "subdomain": "my-app",
    "hascustomDomain": true,
    "customDomain": "www.example.com",
    "plan": "pro"
  }
}

​

Update Subdomain

​

Path Parameters

​

Request Body

​

Validation Rules

• Pattern: Must match regex /^[a-z0-9-]{3,40}$/
• Length: 3-40 characters
• Characters: Lowercase letters (a-z), numbers (0-9), hyphens (-) only
• Uniqueness: Subdomain must not be taken by another active project
• Invalid examples:
  • MY-APP (uppercase not allowed)
  • my_app (underscores not allowed)
  • ab (too short)
  • my app (spaces not allowed)

​

Behavior

1. Validates subdomain format and uniqueness
2. Updates the subdomain in the project document
3. Sets project status to building
4. Updates the port binding allocation
5. Updates Redis cache with new subdomain mapping
6. Queues a container recreation job
7. Project will rebuild and restart with the new subdomain

​

Example Request

curl -X PATCH "https://api.deployhub.online/api/projects/65f3a2b1c4d5e6f7g8h9i0j1/domains/subdomain" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subdomain": "my-awesome-app"
  }'

​

Example Response

{
  "success": true,
  "subdomain": "my-awesome-app",
  "message": "Subdomain updated. Project is restarting."
}

​

Error Responses

{
  "success": false,
  "message": "Invalid subdomain. Use lowercase letters, numbers, hyphens (3-40 chars)."
}

{
  "success": false,
  "message": "Project not found"
}

{
  "success": false,
  "message": "This subdomain is already taken. Please choose another."
}

{
  "success": false,
  "message": "Server error"
}

​

Implementation Notes

​

Subdomain Update Process

1. Validation Phase:
   • Checks subdomain format using regex validation
   • Queries database to ensure subdomain is not already taken
   • Ignores the current project when checking uniqueness
   • Excludes deleted projects from uniqueness check
2. Update Phase:
   • Updates project document with new subdomain
   • Sets status to building (bypasses validation)
   • Updates the Binding (port allocation) document
   • Removes old subdomain from Redis cache
   • Creates new Redis cache entry with port mapping
3. Recreation Phase:
   • Queues a job to deployhub-recreate-container queue
   • Job data includes: projectId, oldcontainername, newcontainername
   • Container is recreated with the new subdomain
   • Project becomes accessible at {new-subdomain}.deployhub.online

​

Redis Cache Structure

• Key: subdomain:{subdomain}
• Value (hash):
  • port: Internal port number for routing
  • projectId: Project identifier
  • plan: Subscription plan for rate limiting

​

Downtime

• Project status is building
• The old subdomain becomes inaccessible
• The new subdomain is not yet available
• Typical recreation time: 1-3 minutes depending on project size

​

Custom Domains

​

Source Reference

• GET domains: backend/src/controllers/slices/Project/domain.controller.js:6
• PATCH subdomain: backend/src/controllers/slices/Project/domain.controller.js:29