All REST Endpoints
List components, read components, delete and restore components, copy and publish components.
- Get Component Details
- Method: getPath:
/sites/management/api/v1/components/{id}
- Get the Query Syntax for Component Resources
- Method: getPath:
/sites/management/api/v1/components/search-form
- Get the User or Application That Created the Component
- Method: getPath:
/sites/management/api/v1/components/{id}/createdBy
- Get the User or Application That Last Modified the Component
- Method: getPath:
/sites/management/api/v1/components/{id}/lastModifiedBy
- Get the User or Application That Owns the Component
- Method: getPath:
/sites/management/api/v1/components/{id}/ownedBy
- List or Batch Read Components
- Method: getPath:
/sites/management/api/v1/components
Soft delete, restore and hard delete for components.
- Hard Delete a Component
- Method: postPath:
/sites/management/api/v1/components/{id}/hardDelete
- Soft Delete a Component
- Method: deletePath:
/sites/management/api/v1/components/{id}
- Undelete a Soft-Deleted Component
- Method: postPath:
/sites/management/api/v1/components/{id}/undelete
Import and export components.
- Export a Component
- Method: postPath:
/sites/management/api/v1/components/{id}/export
- Get an Example Request Body for Creating Component Resources
- Method: getPath:
/sites/management/api/v1/components/create-form
- Import a Component
- Method: postPath:
/sites/management/api/v1/components
Sharing components with users, applications or groups.
- Batch Unshare Users, Applications or Groups
- Method: deletePath:
/sites/management/api/v1/components/{id}/members
- Get an Example Request Body for Creating Component Member Resources
- Method: getPath:
/sites/management/api/v1/components/{id}/members/create-form
- Get an Example Request Body for Editing Component Member Resources
- Method: getPath:
/sites/management/api/v1/components/{id}/members/{memberId}/edit-form
- Get the Group Details for a Member
- Method: getPath:
/sites/management/api/v1/components/{id}/members/{memberId}/group
- Get the Sharing Role for a User, Application or Group
- Method: getPath:
/sites/management/api/v1/components/{id}/members/{memberId}
- Get the User or Application Details for a Member
- Method: getPath:
/sites/management/api/v1/components/{id}/members/{memberId}/user
- Leave the Component
- Method: postPath:
/sites/management/api/v1/components/{id}/members/leave
- List the Users, Applications and Groups a Component is Shared With
- Method: getPath:
/sites/management/api/v1/components/{id}/members
- Share a Component with a User, Application or Group
- Method: postPath:
/sites/management/api/v1/components/{id}/members
- Unshare a Component
- Method: deletePath:
/sites/management/api/v1/components/{id}/members/{memberId}
- Update the Sharing Role
- Method: patchPath:
/sites/management/api/v1/components/{id}/members/{memberId}
Component permissions.
- Get Component Permissions
- Method: getPath:
/sites/management/api/v1/components/{id}/permissions
Publish components.
- Publish Updates Made to a Component
- Method: postPath:
/sites/management/api/v1/components/{id}/publish
Copy components, update the fields of a component.
- Copy a Component
- Method: postPath:
/sites/management/api/v1/components/{id}/copy
- Get an Example Request Body for Editing Component Resources
- Method: getPath:
/sites/management/api/v1/components/{id}/edit-form
- Update the Fields of a Component
- Method: patchPath:
/sites/management/api/v1/components/{id}
Read and update policies associated with site management operations.
- Batch Read Policies
- Method: getPath:
/sites/management/api/v1/policies
- Get Policy Details
- Method: getPath:
/sites/management/api/v1/policies/{id}
- Get the Repository Associated with a Policy
- Method: getPath:
/sites/management/api/v1/policies/{id}/repository
Control who can perform site-management operations using access lists.
- Add a User, Application or Group to the Access List
- Method: postPath:
/sites/management/api/v1/policies/{id}/access
- Add or Remove Users, Applications or Groups from the Access List
- Method: patchPath:
/sites/management/api/v1/policies/{id}/access
- Clear the Access List
- Method: deletePath:
/sites/management/api/v1/policies/{id}/access
- Get an Access List Member
- Method: getPath:
/sites/management/api/v1/policies/{id}/access/{memberId}
- Get an Example Request Body for Creating Policy Access Member Resources
- Method: getPath:
/sites/management/api/v1/policies/{id}/access/create-form
- Get the Group Details for a Member
- Method: getPath:
/sites/management/api/v1/policies/{id}/access/{memberId}/group
- Get the User or Application Details for a Member
- Method: getPath:
/sites/management/api/v1/policies/{id}/access/{memberId}/user
- List Access Members
- Method: getPath:
/sites/management/api/v1/policies/{id}/access
- Remove a User, Application or Group from the Access List
- Method: deletePath:
/sites/management/api/v1/policies/{id}/access/{memberId}
- Replace the Users, Applications or Groups in the Access List
- Method: putPath:
/sites/management/api/v1/policies/{id}/access
- Verify a User, Application or Group Is a Member of the Access List
- Method: postPath:
/sites/management/api/v1/policies/{id}/access/contains
Control who can approve site-management operations using approval lists.
- Add a User, Application or Group to the Approvers List
- Method: postPath:
/sites/management/api/v1/policies/{id}/approvers
- Add or Remove Users, Applications or Groups from the Approvers List
- Method: patchPath:
/sites/management/api/v1/policies/{id}/approvers
- Clear the Approvers List
- Method: deletePath:
/sites/management/api/v1/policies/{id}/approvers
- Get an Approvers List Member
- Method: getPath:
/sites/management/api/v1/policies/{id}/approvers/{memberId}
- Get an Example Request Body for Creating Policy Approvers Member Resources
- Method: getPath:
/sites/management/api/v1/policies/{id}/approvers/create-form
- Get the Group Details for a Member
- Method: getPath:
/sites/management/api/v1/policies/{id}/approvers/{memberId}/group
- Get the User or Application Details for a Member
- Method: getPath:
/sites/management/api/v1/policies/{id}/approvers/{memberId}/user
- List Approvers
- Method: getPath:
/sites/management/api/v1/policies/{id}/approvers
- Remove a User, Application or Group from the Approvers List
- Method: deletePath:
/sites/management/api/v1/policies/{id}/approvers/{memberId}
- Replace the Users, Applications or Groups in the Approvers List
- Method: putPath:
/sites/management/api/v1/policies/{id}/approvers
- Verify a User, Application or Group Is a Member of the Approvers List
- Method: postPath:
/sites/management/api/v1/policies/{id}/approvers/contains
Update the fields of a policy.
- Get an Example Request Body for Editing Policy Resources
- Method: getPath:
/sites/management/api/v1/policies/{id}/edit-form
- Update the Fields of a Policy
- Method: patchPath:
/sites/management/api/v1/policies/{id}
List requests relating to sites, such as requests for new sites and requests to copy sites. Update requests that have been rejected. Retry failed requests.
- Check the Progress of a Request
- Method: getPath:
/sites/management/api/v1/requests/{id}/job
- Get a Request
- Method: getPath:
/sites/management/api/v1/requests/{id}
- Get the Localization Policy for the Target Site
- Method: getPath:
/sites/management/api/v1/requests/{id}/localizationPolicy
- Get the Owner for the Target Site
- Method: getPath:
/sites/management/api/v1/requests/{id}/ownedBy
- Get the Query Syntax for Request Resources
- Method: getPath:
/sites/management/api/v1/requests/search-form
- Get the Repository for the Target Site
- Method: getPath:
/sites/management/api/v1/requests/{id}/repository
- Get the Site Created by the Request
- Method: getPath:
/sites/management/api/v1/requests/{id}/site
- Get the Source Site Associated with the Request
- Method: getPath:
/sites/management/api/v1/requests/{id}/source
- Get the Template Associated with the Request
- Method: getPath:
/sites/management/api/v1/requests/{id}/template
- Get the User or Application That Created the Request
- Method: getPath:
/sites/management/api/v1/requests/{id}/createdBy
- List or Batch Read Site Requests
- Method: getPath:
/sites/management/api/v1/requests
Read and query who can approve a request.
- List Users, Applications or Groups That Can Approve a Request
- Method: getPath:
/sites/management/api/v1/requests/{id}/approvers
- Verify a User, Application or Group Can Approve a Request
- Method: postPath:
/sites/management/api/v1/requests/{id}/approvers/contains
Soft delete, restore and hard delete for requests.
- Batch Delete Requests
- Method: deletePath:
/sites/management/api/v1/requests
- Hard Delete a Request
- Method: postPath:
/sites/management/api/v1/requests/{id}/hardDelete
- Soft Delete a Request
- Method: deletePath:
/sites/management/api/v1/requests/{id}
- Undelete a Soft-Deleted Request
- Method: postPath:
/sites/management/api/v1/requests/{id}/undelete
View reviews for site requests. Approve or reject requests for new sites or requests to copy sites.
- Get a Review
- Method: getPath:
/sites/management/api/v1/requests/{id}/reviews/{reviewId}
- Get an Example Request Body for Creating Review Resources
- Method: getPath:
/sites/management/api/v1/requests/{id}/reviews/create-form
- Get the Query Syntax for Review Resources
- Method: getPath:
/sites/management/api/v1/requests/{id}/reviews/search-form
- Get the User or Application That Created the Review
- Method: getPath:
/sites/management/api/v1/requests/{id}/reviews/{reviewId}/reviewedBy
- List Reviews Added to a Request
- Method: getPath:
/sites/management/api/v1/requests/{id}/reviews
- Reject or Approve a Request
- Method: postPath:
/sites/management/api/v1/requests/{id}/reviews
Update details about a request, retry failed requests.
- Get an Example Request Body for Editing Request Resources
- Method: getPath:
/sites/management/api/v1/requests/{id}/edit-form
- Retry a Failed Request
- Method: postPath:
/sites/management/api/v1/requests/{id}/retry
- Update the Fields of a Request
- Method: patchPath:
/sites/management/api/v1/requests/{id}
Settings.
- Get an Example Request Body for Editing Sites Management Settings Resources
- Method: getPath:
/sites/management/api/v1/settings/edit-form
- Get the Site Management Settings
- Method: getPath:
/sites/management/api/v1/settings
- Update the Site Management Settings
- Method: patchPath:
/sites/management/api/v1/settings
Create new sites, copy sites, list sites, monitor long-running site jobs and activate and deactivate sites.
- Get Default Collection Associated with the Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/defaultCollection
- Get Site Details
- Method: getPath:
/sites/management/api/v1/sites/{id}
- Get the Channel Associated with the Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/channel
- Get the Query Syntax for Request Resources
- Method: getPath:
/sites/management/api/v1/sites/{id}/requests/search-form
- Get the Query Syntax for Site Resources
- Method: getPath:
/sites/management/api/v1/sites/search-form
- Get the Repository Associated with the Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/repository
- Get the Request That Created the Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/request
- Get the Theme Associated With a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/theme
- Get the User or Application That Created the Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/createdBy
- Get the User or Application That Last Modified the Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/lastModifiedBy
- Get the User or Application That Owns the Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/ownedBy
- List or Batch Read Sites
- Method: getPath:
/sites/management/api/v1/sites
- List Requests Relating to a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/requests
Read components, assets and asset types used by a site.
- List the Asset Types Used by a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/assetTypes
- List the Assets Used by a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/assets
- List the Components Used by a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/components
Force a refresh of the pre-rendered site content cache. Read status of latest refresh job, and get information about the last successful site content cache update.
- Refresh Content Cache
- Method: postPath:
/sites/management/api/v1/sites/{id}/refresh
- Site Cache Information
- Method: getPath:
/sites/management/api/v1/sites/{id}/cache
- Site Cache Refresh Status
- Method: getPath:
/sites/management/api/v1/sites/{id}/cache/status
Create and copy sites, update the fields of a site.
- Copy a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/copy
- Create a Site
- Method: postPath:
/sites/management/api/v1/sites
- Create a Template From a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/templates
- Get an Example Request Body for Creating Site Resources
- Method: getPath:
/sites/management/api/v1/sites/create-form
- Get an Example Request Body for Creating Template Resources
- Method: getPath:
/sites/management/api/v1/sites/{id}/templates/create-form
- Get an Example Request Body for Editing Site Resources
- Method: getPath:
/sites/management/api/v1/sites/{id}/edit-form
- Update the Fields of a Site
- Method: patchPath:
/sites/management/api/v1/sites/{id}
Soft delete, restore and hard delete for sites.
- Hard Delete a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/hardDelete
- Restore a Soft-Deleted Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/undelete
- Soft Delete a Site
- Method: deletePath:
/sites/management/api/v1/sites/{id}
Extend the expiration period for a site, read and replace the policy for site expiration.
- Expire Sites
- Method: postPath:
/sites/management/api/v1/sites/_expire
- Expire the Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/expire
- Extend the Expiration Period for a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/extend
Read progress of site-related background operations.
- Batch Read the Progress of Site Related Jobs
- Method: getPath:
/sites/management/api/v1/sites/_status
- Get the Component Created by a Copy Component Job
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/component
- Get the Details of the Translation File being Imported
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/translationImportFile
- Get the Details of the Translation File for a Translation Job
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/translationFile
- Get the Details of the Translation Job
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/translationJob
- Get the Progress of a Site Related Job
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}
- Get the Query Syntax for Site Page Refresh Item Resources
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/pages/search-form
- Get the Site Created by a Copy Site Job
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/site
- Get the Theme Created by a Copy Theme Job
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/theme
- List Pages in a Site Refresh Job
- Method: getPath:
/sites/management/api/v1/sites/_status/{id}/pages
Sharing sites with users, applications or groups.
- Batch Unshare Users, Applications or Groups
- Method: deletePath:
/sites/management/api/v1/sites/{id}/members
- Get an Example Request Body for Creating Site Member Resources
- Method: getPath:
/sites/management/api/v1/sites/{id}/members/create-form
- Get an Example Request Body for Editing Site Member Resources
- Method: getPath:
/sites/management/api/v1/sites/{id}/members/{memberId}/edit-form
- Get the Group Details for a Member
- Method: getPath:
/sites/management/api/v1/sites/{id}/members/{memberId}/group
- Get the Sharing Role for a User, Application or Group
- Method: getPath:
/sites/management/api/v1/sites/{id}/members/{memberId}
- Get the User or Application Details for a Member
- Method: getPath:
/sites/management/api/v1/sites/{id}/members/{memberId}/user
- Leave the Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/members/leave
- List the Users, Applications and Groups a Site is Shared With
- Method: getPath:
/sites/management/api/v1/sites/{id}/members
- Share a Site with a User, Application or Group
- Method: postPath:
/sites/management/api/v1/sites/{id}/members
- Unshare a Site
- Method: deletePath:
/sites/management/api/v1/sites/{id}/members/{memberId}
- Update the Sharing Role
- Method: patchPath:
/sites/management/api/v1/sites/{id}/members/{memberId}
Site permissions.
- Get Site Permissions
- Method: getPath:
/sites/management/api/v1/sites/{id}/permissions
Read and set policies for how sites are copied and expire.
- Get the Copy Policy for a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/copy/policy
- Get the Expiration Policy for a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/extend/policy
- Replace the Copy Policy of a Site
- Method: putPath:
/sites/management/api/v1/sites/{id}/copy/policy
- Replace the Default Expiration Policy of a Site
- Method: putPath:
/sites/management/api/v1/sites/{id}/extend/policy
Publish, validate changes, activate, deactivate and unpublish sites.
- Activate a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/activate
- Deactivate a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/deactivate
- Publish Updates to a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/publish
- Unpublish a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/unpublish
- Validate the Content of a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/validate
Specify named users, applications or groups that can access a site when it goes online. If the site has a security access level that includes named
, the set of users, applications or groups specified will have access to the site after they sign in.
- Batch Remove Users, Applications or Groups
- Method: deletePath:
/sites/management/api/v1/sites/{id}/access
- Get an Access Member
- Method: getPath:
/sites/management/api/v1/sites/{id}/access/{memberId}
- Get an Example Request Body for Creating Site Access Member Resources
- Method: getPath:
/sites/management/api/v1/sites/{id}/access/create-form
- Get the Group Details for a Member
- Method: getPath:
/sites/management/api/v1/sites/{id}/access/{memberId}/group
- Get the User or Application Details for a Member
- Method: getPath:
/sites/management/api/v1/sites/{id}/access/{memberId}/user
- Grant Access to Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/access
- List the Users, Applications and Groups with Access
- Method: getPath:
/sites/management/api/v1/sites/{id}/access
- Remove an Access Member
- Method: deletePath:
/sites/management/api/v1/sites/{id}/access/{memberId}
Create a new translation job for a site. Import site translations.
- Create Translation Job for a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/translate
- Import Site Translations
- Method: postPath:
/sites/management/api/v1/sites/_importTranslations
- Commit Updates to a Site
- Method: postPath:
/sites/management/api/v1/sites/{id}/updates/{updateId}/commit
- Create a New Site Update
- Method: postPath:
/sites/management/api/v1/sites/{id}/updates
- Delete a Site Update
- Method: deletePath:
/sites/management/api/v1/sites/{id}/updates/{updateId}
- Get an Example Request Body for Creating Site Update Resources
- Method: getPath:
/sites/management/api/v1/sites/{id}/updates/create-form
- Get the User or Application That Created the Resource
- Method: getPath:
/sites/management/api/v1/sites/{id}/updates/{updateId}/createdBy
- Get the User or Application That Last Modified the Resource
- Method: getPath:
/sites/management/api/v1/sites/{id}/updates/{updateId}/lastModifiedBy
- Get the User or Application That Owns the Resource
- Method: getPath:
/sites/management/api/v1/sites/{id}/updates/{updateId}/ownedBy
- List The Updates For a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/updates
Configure the vanity domain used by a site. A customer that owns a domain can configure a site to use the domain as its vanity domain, and then the site can be accessed using this domain. A customer must purchase the domain they which to use as a vanity domain. DNS must be setup to point directly to the origin or to a CDN. A CDN allows customers to inject the site path behind-the-scenes so a client doesn't see the internal site path. Multiple sites may be configured to use the same site vanity domain. In that case custom paths for each site must be created, and supported, at the CDN level.
- Create or Replace the Vanity Domain for a Site
- Method: putPath:
/sites/management/api/v1/sites/{id}/vanityDomain
- Read the Vanity Domain for a Site
- Method: getPath:
/sites/management/api/v1/sites/{id}/vanityDomain
- Remove the Vanity Domain for a Site
- Method: deletePath:
/sites/management/api/v1/sites/{id}/vanityDomain
List site templates and images. Create and delete policies associated with templates.
- Get Template Details
- Method: getPath:
/sites/management/api/v1/templates/{id}
- Get the Localization Policy of the Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/localizationPolicy
- Get the Query Syntax for Template Resources
- Method: getPath:
/sites/management/api/v1/templates/search-form
- Get the Theme Associated With a Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/theme
- Get the User or Application That Created the Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/createdBy
- Get the User or Application That Last Modified the Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/lastModifiedBy
- Get the User or Application That Owns the Site
- Method: getPath:
/sites/management/api/v1/templates/{id}/ownedBy
- List or Batch Read Templates
- Method: getPath:
/sites/management/api/v1/templates
- List the Images of a Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/images
Read components, assets and asset types used by a template.
- List the Asset Types Used by a Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/assetTypes
- List the Assets Used by a Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/assets
- List the Components Used by a Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/components
Soft delete, restore and hard delete for templates.
- Hard Delete a Template
- Method: postPath:
/sites/management/api/v1/templates/{id}/hardDelete
- Restore a Soft-Deleted Template
- Method: postPath:
/sites/management/api/v1/templates/{id}/undelete
- Soft Delete a Template
- Method: deletePath:
/sites/management/api/v1/templates/{id}
Import and export templates as template packages.
- Export a Template
- Method: postPath:
/sites/management/api/v1/templates/{id}/export
- Get an Example Request Body for Creating Template Resources
- Method: getPath:
/sites/management/api/v1/templates/create-form
- Import a Template Package
- Method: postPath:
/sites/management/api/v1/templates
- Import Default Templates
- Method: postPath:
/sites/management/api/v1/templates/_import
Read progress of template-related background operations.
- Batch Read the Progress of Template Related Jobs
- Method: getPath:
/sites/management/api/v1/templates/_status
- Get the Progress of a Template Related Job
- Method: getPath:
/sites/management/api/v1/templates/_status/{id}
- Get the Template Created by an Import Job
- Method: getPath:
/sites/management/api/v1/templates/_status/{id}/template
- Get the Theme Created by an Import Job
- Method: getPath:
/sites/management/api/v1/templates/_status/{id}/theme
Sharing templates with users, applications or groups.
- Batch Unshare Users, Applications or Groups
- Method: deletePath:
/sites/management/api/v1/templates/{id}/members
- Get an Example Request Body for Creating Template Member Resources
- Method: getPath:
/sites/management/api/v1/templates/{id}/members/create-form
- Get an Example Request Body for Editing Template Member Resources
- Method: getPath:
/sites/management/api/v1/templates/{id}/members/{memberId}/edit-form
- Get the Group Details for a Member
- Method: getPath:
/sites/management/api/v1/templates/{id}/members/{memberId}/group
- Get the Sharing Role for a User or Group
- Method: getPath:
/sites/management/api/v1/templates/{id}/members/{memberId}
- Get the User or Application Details for a Member
- Method: getPath:
/sites/management/api/v1/templates/{id}/members/{memberId}/user
- Leave the Template
- Method: postPath:
/sites/management/api/v1/templates/{id}/members/leave
- List the Users, Applications and Groups a Template is Shared With
- Method: getPath:
/sites/management/api/v1/templates/{id}/members
- Share a Template with a User, Application or Group
- Method: postPath:
/sites/management/api/v1/templates/{id}/members
- Unshare a Template
- Method: deletePath:
/sites/management/api/v1/templates/{id}/members/{memberId}
- Update the Sharing Role
- Method: patchPath:
/sites/management/api/v1/templates/{id}/members/{memberId}
Template permissions.
- Get Template Permissions
- Method: getPath:
/sites/management/api/v1/templates/{id}/permissions
Read and set policies for how templates are used to create sites.
- Associate a Policy with a Template
- Method: postPath:
/sites/management/api/v1/templates/{id}/policy
- Get an Example Request Body for Creating Policy Resources
- Method: getPath:
/sites/management/api/v1/templates/{id}/policy/create-form
- Get the Site Creation Policy for a Template
- Method: getPath:
/sites/management/api/v1/templates/{id}/policy
- Unlink the Policy Associated with a Template
- Method: deletePath:
/sites/management/api/v1/templates/{id}/policy
Copy templates, update the fields of a template.
- Copy a Template
- Method: postPath:
/sites/management/api/v1/templates/{id}/copy
- Get an Example Request Body for Editing Template Resources
- Method: getPath:
/sites/management/api/v1/templates/{id}/edit-form
- Update the Fields of a Template
- Method: patchPath:
/sites/management/api/v1/templates/{id}
List themes, read themes, delete and restore themes, copy and publish themes.
- Get the Query Syntax for Theme Resources
- Method: getPath:
/sites/management/api/v1/themes/search-form
- Get the Running Job Associated with the Theme
- Method: getPath:
/sites/management/api/v1/themes/{id}/job
- Get the User or Application That Created the Theme
- Method: getPath:
/sites/management/api/v1/themes/{id}/createdBy
- Get the User or Application That Last Modified the Theme
- Method: getPath:
/sites/management/api/v1/themes/{id}/lastModifiedBy
- Get the User or Application That Owns the Theme
- Method: getPath:
/sites/management/api/v1/themes/{id}/ownedBy
- Get Theme Details
- Method: getPath:
/sites/management/api/v1/themes/{id}
- List or Batch Read Themes
- Method: getPath:
/sites/management/api/v1/themes
Soft delete, restore and hard delete for themes.
- Hard Delete a Theme
- Method: postPath:
/sites/management/api/v1/themes/{id}/hardDelete
- Soft Delete a Theme
- Method: deletePath:
/sites/management/api/v1/themes/{id}
- Undelete a Soft-Deleted Theme
- Method: postPath:
/sites/management/api/v1/themes/{id}/undelete
Sharing themes with users, applications or groups.
- Batch Unshare Users, Applications or Groups
- Method: deletePath:
/sites/management/api/v1/themes/{id}/members
- Get an Example Request Body for Creating Theme Member Resources
- Method: getPath:
/sites/management/api/v1/themes/{id}/members/create-form
- Get an Example Request Body for Editing Theme Member Resources
- Method: getPath:
/sites/management/api/v1/themes/{id}/members/{memberId}/edit-form
- Get the Group Details for a Member
- Method: getPath:
/sites/management/api/v1/themes/{id}/members/{memberId}/group
- Get the Sharing Role for a User, Application or Group
- Method: getPath:
/sites/management/api/v1/themes/{id}/members/{memberId}
- Get the User or Application Details for a Member
- Method: getPath:
/sites/management/api/v1/themes/{id}/members/{memberId}/user
- Leave the Theme
- Method: postPath:
/sites/management/api/v1/themes/{id}/members/leave
- List the Users, Applications and Groups a Theme is Shared With
- Method: getPath:
/sites/management/api/v1/themes/{id}/members
- Share a Theme with a User, Application or Group
- Method: postPath:
/sites/management/api/v1/themes/{id}/members
- Unshare a Theme
- Method: deletePath:
/sites/management/api/v1/themes/{id}/members/{memberId}
- Update the Sharing Role
- Method: patchPath:
/sites/management/api/v1/themes/{id}/members/{memberId}
Theme permissions.
- Get Theme Permissions
- Method: getPath:
/sites/management/api/v1/themes/{id}/permissions
Publish themes.
- Publish Updates Made to a Theme
- Method: postPath:
/sites/management/api/v1/themes/{id}/publish
Copying themes and updating the fields of a theme.
- Copy a Theme
- Method: postPath:
/sites/management/api/v1/themes/{id}/copy
- Get an Example Request Body for Editing Theme Resources
- Method: getPath:
/sites/management/api/v1/themes/{id}/edit-form
- Update the Fields of a Theme
- Method: patchPath:
/sites/management/api/v1/themes/{id}