List content sources

1 min

GET

/_cms/v1/contentsources

List content sources using the provided options.

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

ContentSourcePage
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.
- itemsContentSource[]
  Description
  The items in this paged collection.
  - keystring
    Description
    The unique identifier (key) of the resource.
    Min Length
    2
    Max Length
    255
    Pattern
    ^[A-Za-z][_0-9A-Za-z]+$
  - typestringrequired
    Description
    Specifies the type of source. For example 'graph' for a GraphQL content source.
    Min Length
    1
    Max Length
    50
  - sourceKeystringrequired
    Description
    The key of the source that this ContentSource relates to.
    Min Length
    1
    Max Length
    50
  - sourceTypestringrequired
    Description
    Specifies the source type of this source.
    Min Length
    2
    Max Length
    255
    Pattern
    ^[A-Za-z][_0-9A-Za-z]+$
  - displayNamestringrequired
    Description
    The display name of this ContentSource.
    Min Length
    1
    Max Length
    255
  - createdstring<date-time>
    Description
    A timestamp indicating when this resource was first created.
    Format
    date-time
  - createdBystring
    Description
    The name of the user or application that created this resource.
  - lastModifiedstring<date-time>
    Description
    Indicates the last time this resource was modified.
    Format
    date-time
  - lastModifiedBystring
    Description
    The name of the user or application that last modified this resource.
  - baseTypestring<_page | _component | _media | _image | _video | _folder | _experience | _section | _element>required
    Description
    Represents the base of the corresponding content type.
    Allowed
    _page_component_media_image_video_folder_experience_section_element
  - propertyMappingsPropertyMappingsrequired
    Description
    Represents a mapping between a property in an external source and its corresponding property in the CMS. Used to define how external properties are mapped to CMS property identifiers and names.
    - keystring
      Description
      The key to use for the item in the source. Required if the SourceType is not of type '_Item'.
      Max Length
      255
    - displayNamestring
      Description
      The key to use for the item in cms. Required if the SourceType is not of type '_Item'.
      Max Length
      255
    - keyFormatstring
      Description
      Specifies the format of the source identifier key.
      Pattern
      ^digits$|^digitsWithHyphens$|^digitsWithHyphensAndBraces$|^digitsWithHyphensAndParentheses$|^digitsWithThreeHyphens$|^undefined$
- 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

500Internal Server Error

curl

curl --request GET \
     --url /_cms/v1/contentsources \
     --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/contentsources", 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/contentsources")

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/contentsources"

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

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

print(response.text)

200

// OK
{
  "items": [
    {
      "key": "",
      "type": "",
      "sourceKey": "",
      "sourceType": "",
      "displayName": "",
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": "",
      "baseType": "",
      "propertyMappings": {
        "key": "",
        "displayName": "",
        "keyFormat": ""
      }
    }
  ],
  "pageIndex": "",
  "pageSize": "",
  "totalCount": ""
}

401

// Unauthorized

403

// Forbidden

500

// Internal Server Error