Subdomain

List subdomains

get

Returns all subdomains of the authenticated user. Requires Platinum plan or higher.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Responses

200

List of subdomains returned successfully

application/json

anyOptional

401

Authentication error

application/json

403

Insufficient plan

application/json

get

/subdomain/all

HTTPcURLJavaScriptPython

GET /v2/subdomain/all HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "subdomains": [
    {
      "id": "meu-subdomain",
      "userID": "803658045736878080",
      "status": 1,
      "date": 1745100000000
    }
  ]
}

Get subdomain

get

Returns information about a specific subdomain of the user. Requires Platinum plan or higher.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

subdomainNamestringRequired

Subdomain name (without the .discloud.app suffix)

Responses

200

Subdomain returned successfully

application/json

anyOptional

401

Authentication error

application/json

403

Insufficient plan or no permission

application/json

404

Subdomain not found

application/json

409

Subdomain already registered

application/json

get

/subdomain/{subdomainName}

HTTPcURLJavaScriptPython

GET /v2/subdomain/{subdomainName} HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "subdomain": {
    "id": "meu-subdomain",
    "userID": "803658045736878080",
    "status": 1,
    "date": 1745100000000
  }
}

Create subdomain

post

Creates a new subdomain. Requires Platinum plan or higher. Maximum of 100 subdomains per user.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

subdomainNamestringRequired

Desired subdomain name (without the .discloud.app suffix)

Pattern: ^[a-z0-9-]{2,20}$

Responses

201

Subdomain created successfully

application/json

400

Invalid subdomain name or inappropriate word

application/json

401

Authentication error

application/json

403

Insufficient plan or limit reached

application/json

409

Subdomain already registered

application/json

post

/subdomain/{subdomainName}

HTTPcURLJavaScriptPython

POST /v2/subdomain/{subdomainName} HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Subdomain created successfully",
  "subdomain": {
    "id": "meu-subdomain",
    "userID": "803658045736878080",
    "status": 1,
    "date": 1745100000000
  }
}

Delete subdomain

delete

Deletes a user's subdomain. Cannot delete subdomains that are in use (status 2). Requires Platinum plan or higher.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

subdomainNamestringRequired

Subdomain name to be deleted

Responses

200

Subdomain deleted successfully

application/json

statusstringOptional

messagestringOptional

401

Authentication error

application/json

403

Insufficient plan or no permission

application/json

404

Subdomain not found

application/json

409

Subdomain in use

application/json

delete

/subdomain/{subdomainName}

HTTPcURLJavaScriptPython

DELETE /v2/subdomain/{subdomainName} HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Subdomain removed successfully"
}