> 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"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.discloud.com/api-and-integrations/api-overview/subdomain.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.