> For the complete documentation index, see [llms.txt](https://docs.discloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.discloud.com/api-and-integrations/api-overview/subdomain.md).

# Subdominio

## Listar subdomínios

> Retorna todos os subdomínios do usuário autenticado. Requer plano Platinum ou superior.

```json
{"openapi":"3.0.4","info":{"title":"Discloud API","version":"2.0.0"},"tags":[{"name":"Subdomínios","description":"Operações sobre subdomínios"}],"servers":[{"url":"https://api.discloud.app/v2","description":"Servidor API"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-token"}},"schemas":{"Error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/subdomain/all":{"get":{"tags":["Subdomínios"],"summary":"Listar subdomínios","description":"Retorna todos os subdomínios do usuário autenticado. Requer plano Platinum ou superior.","operationId":"listSubdomains","responses":{"200":{"description":"Lista de subdomínios retornada com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubdomainListResponse"}}}},"401":{"description":"Erro de autenticação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plano insuficiente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Obter subdomínio

> Retorna as informações de um subdomínio específico do usuário. Requer plano Platinum ou superior.

```json
{"openapi":"3.0.4","info":{"title":"Discloud API","version":"2.0.0"},"tags":[{"name":"Subdomínios","description":"Operações sobre subdomínios"}],"servers":[{"url":"https://api.discloud.app/v2","description":"Servidor API"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-token"}},"schemas":{"Error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/subdomain/{subdomainName}":{"get":{"tags":["Subdomínios"],"summary":"Obter subdomínio","description":"Retorna as informações de um subdomínio específico do usuário. Requer plano Platinum ou superior.","operationId":"getSubdomain","parameters":[{"name":"subdomainName","in":"path","required":true,"description":"Nome do subdomínio (sem o sufixo .discloud.app)","schema":{"type":"string"}}],"responses":{"200":{"description":"Subdomínio retornado com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubdomainResponse"}}}},"401":{"description":"Erro de autenticação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plano insuficiente ou sem permissão","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Subdomínio não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Criar subdomínio

> Cria um novo subdomínio. Requer plano Platinum ou superior. Máximo de 100 subdomínios por usuário.

```json
{"openapi":"3.0.4","info":{"title":"Discloud API","version":"2.0.0"},"tags":[{"name":"Subdomínios","description":"Operações sobre subdomínios"}],"servers":[{"url":"https://api.discloud.app/v2","description":"Servidor API"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-token"}},"schemas":{"Error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/subdomain/{subdomainName}":{"post":{"tags":["Subdomínios"],"summary":"Criar subdomínio","description":"Cria um novo subdomínio. Requer plano Platinum ou superior. Máximo de 100 subdomínios por usuário.","operationId":"createSubdomain","parameters":[{"name":"subdomainName","in":"path","required":true,"description":"Nome desejado para o subdomínio (sem o sufixo .discloud.app)","schema":{"type":"string","pattern":"^[a-z0-9-]{2,20}$"}}],"responses":{"201":{"description":"Subdomínio criado com sucesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubdomainResponse"}}}},"400":{"description":"Nome de subdomínio inválido ou palavra inapropriada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Erro de autenticação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plano insuficiente ou limite atingido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Subdomínio já registrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Remover subdomínio

> Remove um subdomínio do usuário. Não é possível remover subdomínios que estejam em uso (status 2). Requer plano Platinum ou superior.

```json
{"openapi":"3.0.4","info":{"title":"Discloud API","version":"2.0.0"},"tags":[{"name":"Subdomínios","description":"Operações sobre subdomínios"}],"servers":[{"url":"https://api.discloud.app/v2","description":"Servidor API"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-token"}},"schemas":{"Error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/subdomain/{subdomainName}":{"delete":{"tags":["Subdomínios"],"summary":"Remover subdomínio","description":"Remove um subdomínio do usuário. Não é possível remover subdomínios que estejam em uso (status 2). Requer plano Platinum ou superior.","operationId":"deleteSubdomain","parameters":[{"name":"subdomainName","in":"path","required":true,"description":"Nome do subdomínio a ser removido","schema":{"type":"string"}}],"responses":{"200":{"description":"Subdomínio removido com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}}}}},"401":{"description":"Erro de autenticação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Plano insuficiente ou sem permissão","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Subdomínio não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Subdomínio em uso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```