hosting

GET /v1/sites/{siteId}/cms-target

Where this site's posts go.

Todos los endpoints de hosting

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

The site's content target. Gated on `links.view`. ⛔ A site with no configured target is **200, not 404**. Most WordPress sites on our own fleet need no configuration at all — we hold a managed shell on the box, so the target is derived from the site — and the response then describes that derived target and its capabilities with `hasCredential: false`. Treating "no row" as "no target" would report most of the estate as unconfigured. ⛔ No secret is ever returned, in any form — not masked, not last-four. `hasCredential` is a boolean and the only consumer of the value is the adapter making the call.

Parámetros

NombreTipoObligatorio¿Qué es esto?
siteId (path)string

Respuesta

NombreTipoObligatorio¿Qué es esto?
site_idstring
kindstring<, wordpress, headless_rest, git_static>Empty when nothing claims this site. For a site with no configured row this is the **derived** target — most WordPress sites on our own fleet need no configuration at all, becau…
presetstring<, payload, strapi, directus, ghost, shopify, webflow, custom>
base_urlstringThe CMS's API root. Empty for a target whose address is derived from the site (fleet WordPress, a connected Git repository).
collectionstringThe collection posts are created in — `posts` on Payload, a blog id on Shopify, a collection id on Webflow, the content directory on a Git target.
auth_schemestring<, bearer, payload_api_key, ghost_admin_jwt, shopify_token, header>
auth_headerstringFor the `header` auth scheme — which header the key is sent in.
field_mapobjectRenames, for a destination that spells our fields differently. ⛔ It **renames**; it never adds a capability. A field map cannot make a target able to carry a tag it has no field…
enabledbooleanA disabled target is skipped and reads as `needs_setup` — kept rather than deleted so pausing publishing to a site does not lose its set-up.
has_credentialboolean
capabilitiesstring[]
detected_identitystringWhat the destination said it was, last time it answered.
last_probe_atstring
last_probe_reachableboolean⛔ `null` means **never probed**; `false` means probed and could not be reached. Those are different facts and a client must not render them the same.
last_probe_codestring
last_probe_detailstring

Errores que este endpoint puede devolver

401 · 403 · 404