Content

List a site's content keys

Lists the content keys of a site as the draft sees them: a staged edit replaces the live version and a staged delete hides it. That covers pages, layouts, fragments and data files. Site and page briefs are not listed. Each row's status tells you whether the key is live, modified or new. To read a key's body use GET …/content/{key}.

get/api/v1/sites/{slug}/content

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/content
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Query parameters

limitinteger

Page size, 1 to 1000. Defaults to 1000; larger values are clamped. Follow nextCursor for the rest.

cursorstring

Opaque value from the previous page's nextCursor. Do not build one yourself.

withSizeboolean

Measure size for every returned row (one storage read each). Without it, size is measured only on pages of 100 rows or fewer.

Response

One page of content keys.

nextCursorstring nullable required

Pass as cursor (with the same limit) for the next page; null on the last page.

partialboolean required

true when these keys are one window of the site's key space rather than all of it (the page index was missing, so the keys were read in bounded windows). Keep following nextCursor: a null cursor with partial: true does not mean the site is small.

Example response

{
  "content": [
    {
      "key": "about.html",
      "contentType": "text/html; charset=utf-8",
      "contentHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.