hosting

GET /v1/sites/{siteId}/transfer

Get this site's most recent transfer offer.

Todos os endpoints de hosting

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/transfer \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

The latest offer for this site, in any state, so the site page can show either a pending handover or the outcome of the last one. `404` when the site has never been offered. Requires `sites.view`.

Parâmetros

NomeTipoObrigatórioO que é
siteId (path)UuidSimSite ID (UUIDv7).

Resposta

NomeTipoObrigatórioO que é
idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_namestringNãoThe site's name as it was when the offer was made. Snapshotted onto the offer, not read live: while a transfer is pending the site still belongs to the sender, and reading it li…
primary_domainstringNãoThe site's domain as it was when the offer was made. Snapshotted, as above.
directionstring<incoming, outgoing>SimFrom **this caller's** point of view. Computed per request, never stored — the same row is outgoing to one party and incoming to the other.
statusstring<pending, accepted, declined, cancelled, expired, failed>SimFive terminal states rather than one, because *why* an offer ended is what support is actually asked. `failed` means it was accepted and could not complete; nothing moved.
include_domainbooleanSimWhether the domain, its DNS and its mail travel with the site.
recipient_emailstringNãoOnly populated for the **sender**. To the receiver it is their own address and carries no information; to anyone else it would be a third party's email address in a row two orga…
messagestringNão
expires_atstringSimAn unaccepted offer expires fourteen days after it is made.
term_ends_atstringNão
renewal_amount_minorintegerNão
renewal_currencystringNão
created_atstringSim
decided_atstringNão
failure_reasonstringNãoWhy a `failed` transfer could not complete. Empty otherwise.

Erros que este endpoint pode retornar

401 · 403 · 404 · 429