Object Revisions

The following endpoints allow you to get Revision of your Object in your Bucket.

✅

Quick Tip
Your read and write keys will be required to perform the following requests. These can be found in Your Bucket > Settings > API Access in your Bucket Dashboard .

Get Object Revisions

Get Object Revisions of Object with id in your Bucket.

Parameter	Required	Type	Default	Description
read_key	required	String		Restrict read access to your Bucket
query		JSON		A JSON string to perform Object search and filtering. See Queries section for more detail.
show_metafields		Enum	false	true, Shows metafields
props		String		Declare which properties to return in comma-separated string. Reference full Object for all available properties. Example: `?props=id,title,metadata.author`
sort		Enum	order	created_at, -created_at, modified_at, -modified_at, random, order
limit		Number	1000	The number of Objects to return
skip		Number	0	The number of Objects to skip
pretty		Enum	false	true, Makes the response more reader-friendly

Methods

REST
Node.js
GraphQL


GET $BASE_URL/buckets/${bucket_slug}/objects/${object_id}/revisions

Example Response


{
  "revisions": [
    {
      "id": "5ff75368c2dfa81a91695cec",
      "slug": "title-of-the-post",
      "title": "Title of the Post",
      "content": "",
      "bucket": "5f7357124b331d76c08de989",
      "created_at": "2021-01-07T18:31:04.005Z",
      "modified_at": "2021-01-07T18:31:04.005Z",
      "status": "published",
      "published_at": "2021-01-07T18:31:04.005Z",
      "object_id": "5ff75368c2dfa81a91695cec",
      "type": "posts",
      "metadata": null
    },
    {
      "id": "5ff754491a90d61b34aacdbe",
      "slug": "title-of-the-post",
      "title": "This is updated Title",
      "content": "",
      "bucket": "5f7357124b331d76c08de989",
      "created_at": "2021-01-07T18:34:49.828Z",
      "modified_at": "2021-01-07T18:34:49.828Z",
      "status": "published",
      "published_at": "2021-01-07T18:31:04.005Z",
      "object_id": "5ff75368c2dfa81a91695cec",
      "type": "posts",
      "metadata": null
    }
  ],
  "total": 4,
  "limit": 2
}

Get Object Revision

Returns a single Revision by id from your Object.

Parameter	Required	Type	Default	Description
read_key	required	String		Restrict read access to your Bucket
show_metafields		Enum	false	true, Shows metafields
props		String		Declare which properties to return in comma-separated string. Reference full Object for all available properties. Example: `?props=id,title,metadata.author`
pretty		Enum	false	true, Makes the response more reader-friendly

Definition


GET $BASE_URL/buckets/${bucket_slug}/objects/${object_id}/revisions/${revision_id}

Example Response


{
  "revision": {
    "id": "5ff75368c2dfa81a91695cec",
    "slug": "title-of-the-post",
    "title": "Title of the Post",
    "content": "",
    "bucket": "5f7357124b331d76c08de989",
    "created_at": "2021-01-07T18:31:04.005Z",
    "modified_at": "2021-01-07T18:31:04.005Z",
    "status": "published",
    "published_at": "2021-01-07T18:31:04.005Z",
    "object_id": "5ff75368c2dfa81a91695cec",
    "type": "posts",
    "metadata": null
  }
}

Add Object Revision

Add a new Revision to your Object.

⚠

Required
write_key must be passed as Authorization Bearer in the header of the request.

Parameter	Required	Type	Description
title	required	String	Your Object title
slug		String	Unique identifier for your Object
content		String	Add Content to your Object
status		Enum	draft, published, defaults to published
metafields		Array of Objects	Add Metafields to your Object. See Metafields Model.
created_by		String	Author User Id
publish_at		Number	UNIX millisecond timestamp. Publish automatically at a later time.
options.slug_field		Boolean	Set to false to hide the slug field
options.content_editor		Boolean	Set to false to hide the content editor
locale		String	Add localization to the Object
thumbnail		String	Media `name`. Media must be available in Bucket. See Media.
trigger_webhook		Boolean	Triggers corresponding Object action Webhook (See Webhooks).
pretty		Enum	true, Makes the response more reader-friendly

Methods

REST
Node.js
GraphQL
CLI


POST $BASE_URL/buckets/${bucket_slug}/objects/${object_id}/revisions

Header


{
  "Authorization": "Bearer n5MbD59UPBoVpyqi6B6DnOzAvZ..."
}

Example Body (JSON)


{
  "title": "New Title of the Post",
  "slug": "new-title-of-the-post"
}

Example Response


{
  "revision": {
    "id": "5ff75368c2dfa81a91695cec",
    "slug": "title-of-the-post",
    "title": "Title of the Post",
    "content": "",
    "metafields": [],
    "bucket": "5f7357124b331d76c08de989",
    "created_at": "2021-01-07T18:31:04.005Z",
    "modified_at": "2021-01-07T18:31:04.005Z",
    "status": "published",
    "published_at": "2021-01-07T18:31:04.005Z",
    "type": "posts"
  }
}

Object Revisions

Get Object Revisions#

Get Object Revision#

Add Object Revision#

Get Object Revisions

Get Object Revision

Add Object Revision