List applications

1 min

GET

/_cms/v1/applications

List all applications available in the CMS.

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

ApplicationPage
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.
- itemsApplication[]
  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]+$
  - displayNamestringrequired
    Description
    The display name of this Application.
    Min Length
    1
    Max Length
    255
  - typeApplicationTyperequired
    Description
    Represents the type of an Application.
  - sourcestring
    Description
    A string that is used to indicate the source of this Application.
  - entryPointstring<uri>required
    Description
    A reference to the entry point (start page) content for this application.
    Format
    uri
  - isDefaultboolean
    Description
    Whether this is the default application.
  - useApplicationSpecificAssetsboolean
    Description
    Whether this application uses a dedicated assets folder.
  - assetsRootstring<uri>
    Description
    Returns the root for application-specific assets, if UseApplicationSpecificAssets is true.
    Format
    uri
  - hostsApplicationHost[]
    Description
    The hosts assigned to this application.
    - authoritystringrequired
      Description
      The DNS host name or IP address and optional port of this host.
      Min Length
      1
      Max Length
      255
    - typeApplicationHostType
      Description
      Represents the type of an ApplicationHost.
    - localestring
      Description
      The locale associated with this host.
    - preferredUrlSchemeUrlScheme
      Description
      Specifies the preferred URL scheme to be used when accessing a host.
  - usePreviewTokensboolean
    Description
    Whether to use preview tokens for this application. Only applicable when the type is 'website'.
  - previewUrlFormatsmap<string, string>
    Description
    A dictionary of preview URL formats keyed by content type base or content type key. Only applicable when the type is 'website'.
  - 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.
- 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/applications \
     --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/applications", 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/applications")

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

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": "",
      "displayName": "",
      "type": {},
      "source": "",
      "entryPoint": "",
      "isDefault": false,
      "useApplicationSpecificAssets": false,
      "assetsRoot": "",
      "hosts": [
        {
          "authority": "",
          "type": {},
          "locale": "",
          "preferredUrlScheme": {}
        }
      ],
      "usePreviewTokens": false,
      "previewUrlFormats": "",
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": ""
    }
  ],
  "pageIndex": "",
  "pageSize": "",
  "totalCount": ""
}

401

// Unauthorized

403

// Forbidden

500

// Internal Server Error