Jump to

• Request
• Response
• Examples

View all sites defined in a application

get

/gsadmin/v1/{appName}/pages

Returns a list of all sites defined for given application. If zip extension is specified (add ".zip" at the end of the path), all site configurations are exported as a zip file.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

List of sites defined for your application.

Body ()

Root Schema : SiteHome

Type: object

Represents a site folder under which a user can create and manage site specific pages

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: site-home

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"site-home"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents a site folder under which a user can create and manage site specific pages"
}

Back to Top

Examples

The following example shows how to view a list of all sites defined for the cloud application:

curl -H "Authorization:Bearer <token>" -X GET http://host:port/gsadmin/v1/cloud/pages (JSON format)

curl -H "Authorization:Bearer <token>" -X GET http://host:port/gsadmin/v1/cloud/pages.zip (ZIP format)

Back to Top