Atualizar Domínio do Projeto

Altera o subdomain do projeto na plataforma Zenifra.

PATCH /project/:id/domain

Parâmetros de Path

Parâmetro	Tipo	Descrição
`id`	string	ID do projeto (ObjectId)

Headers

Header	Obrigatório	Descrição
`x-api-key`	Sim	API Key do projeto
`x-organization-id`	Sim	Organização ativa do projeto
`Content-Type: application/json`	Sim	Necessário por haver body JSON

Body

Campo	Tipo	Obrigatório	Descrição
`domain`	string	Sim	Novo subdomain (mínimo 6 caracteres, máximo 32, apenas letras minúsculas, pode usar hífen)

Exemplo

{
  "domain": "meu-subdomain"
}

Resposta

{
  "status": "success",
  "message": "updated with success"
}

Exemplos

curl -X PATCH "https://api.zenifra.com/v1/project/507f1f77bcf86cd799439011/domain" \
  -H "x-api-key: sua-api-key" \
  -H "x-organization-id: sua-organization-id" \
  -H "Content-Type: application/json" \
  -d '{"domain": "meu-subdomain"}'

Python

import requests

API_KEY = "sua-api-key"
ORGANIZATION_ID = "sua-organization-id"
PROJECT_ID = "507f1f77bcf86cd799439011"

response = requests.patch(
    f"https://api.zenifra.com/v1/project/{PROJECT_ID}/domain",
    headers={"x-api-key": API_KEY, "x-organization-id": ORGANIZATION_ID},
    json={"domain": "meu-subdomain"}
)
print(response.json())

Regras do Domínio

Mínimo de 6 caracteres
Máximo de 32 caracteres
Apenas letras minúsculas e hífens
Não pode começar ou terminar com hífen
O domínio padrão resultante da Zenifra usa a zona clients.zenifra.com

Nessa Página