profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Tanpa kepala

Mulai CepatSplit Screen JSON Component Builder with LLMPenarikan Komponen Zod

REST API

ikhtisar API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Ambil definisi lengkap field sebuah komponen kustom berdasarkan nama.

Ambil definisi lengkap satu komponen kustom berdasarkan nama, termasuk daftar field-nya.

Auth: Kunci API (header x-api-key atau parameter kueri api_key).

Parameter path

ParameterTipeWajibCatatan
namestringyaNama skema, misalnya post.

Parameter kueri

ParameterTipeWajibCatatan
websiteIduuidyaHarus berupa UUID yang valid.
api_keystringtidakAlternatif untuk header x-api-key.

Respons

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "Sebuah Post dokumentasi",
  "category": "Kustom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields dihitung — nama semua field bertipe string.

Contoh

curl '{CMS_API_URL}/components/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>'

Kesalahan

  • 400 — websiteId hilang atau tidak valid
  • 401 — kunci API tidak valid
  • 404 — skema tidak ditemukan
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›