Get preview URLs for a content item version.

1 min

GET

/_cms/v1/content/{key}/versions/{version}/previews

Generate preview URLs for the content item with fresh authentication tokens.

Path Parameters

keystringrequired
Description
The key of the content item.
versionstringrequired
Description
The version of the content item.

Query Parameters

pageIndexinteger<int32>
Description
Zero based index of the page that should be retrieved.
Format
int32
Minimum
0
Maximum
10000
pageSizeinteger<int32>
Description
The maximum items per page that should be retrieved.
Format
int32
Minimum
1
Maximum
10000

Responses

200OK

PreviewPage
Description
Represents a single page of items in a paged collection, including paging metadata such as the current page index, page size, and an estimated total item count.
- itemsPreview[]
  Description
  The items in this paged collection.
  - applicationstring
    Description
    The application that this preview URL is associated with.
  - urlstring
    Description
    The preview URL (may be relative or absolute).
- pageIndexinteger<int32>
  Description
  The zero-based index of the current page.
  Format
  int32
- pageSizeinteger<int32>
  Description
  The number of items in each page. Not necessarily the same as the number of items in this page.
  Format
  int32
- totalCountinteger<int32>
  Description
  The estimated total number of items in the collection. May be omitted if the total count is unknown.
  Format
  int32

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

curl

curl --request GET \
     --url /_cms/v1/content/{key}/versions/{version}/previews \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/_cms/v1/content/{key}/versions/{version}/previews", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/_cms/v1/content/{key}/versions/{version}/previews")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/_cms/v1/content/{key}/versions/{version}/previews"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "items": [
    {
      "application": "",
      "url": ""
    }
  ],
  "pageIndex": "",
  "pageSize": "",
  "totalCount": ""
}

401

// Unauthorized

403

// Forbidden

404

// Not Found

500

// Internal Server Error