Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Try Out the APIs
• Error Messages

Tasks

• Components
  • Get Component Details
  • Get the Query Syntax for Component Resources
  • Get the User or Application That Created the Component
  • Get the User or Application That Last Modified the Component
  • Get the User or Application That Owns the Component
  • List or Batch Read Components
  • Delete and Restore
    • Hard Delete a Component
    • Soft Delete a Component
    • Undelete a Soft-Deleted Component
  • Importing and Exporting
    • Export a Component
    • Get an Example Request Body for Creating Component Resources
    • Import a Component
  • Members
    • Batch Unshare Users, Applications or Groups
    • Get an Example Request Body for Creating Component Member Resources
    • Get an Example Request Body for Editing Component Member Resources
    • Get the Group Details for a Member
    • Get the Sharing Role for a User, Application or Group
    • Get the User or Application Details for a Member
    • Leave the Component
    • List the Users, Applications and Groups a Component is Shared With
    • Share a Component with a User, Application or Group
    • Unshare a Component
    • Update the Sharing Role
  • Permissions
    • Get Component Permissions
  • Publishing
    • Publish Updates Made to a Component
  • Updating and Copying
    • Copy a Component
    • Get an Example Request Body for Editing Component Resources
    • Update the Fields of a Component
• Policies
  • Batch Read Policies
  • Get Policy Details
  • Get the Repository Associated with a Policy
  • Access Lists
    • Add a User, Application or Group to the Access List
    • Add or Remove Users, Applications or Groups from the Access List
    • Clear the Access List
    • Get an Access List Member
    • Get an Example Request Body for Creating Policy Access Member Resources
    • Get the Group Details for a Member
    • Get the User or Application Details for a Member
    • List Access Members
    • Remove a User, Application or Group from the Access List
    • Replace the Users, Applications or Groups in the Access List
    • Verify a User, Application or Group Is a Member of the Access List
  • Approval Lists
    • Add a User, Application or Group to the Approvers List
    • Add or Remove Users, Applications or Groups from the Approvers List
    • Clear the Approvers List
    • Get an Approvers List Member
    • Get an Example Request Body for Creating Policy Approvers Member Resources
    • Get the Group Details for a Member
    • Get the User or Application Details for a Member
    • List Approvers
    • Remove a User, Application or Group from the Approvers List
    • Replace the Users, Applications or Groups in the Approvers List
    • Verify a User, Application or Group Is a Member of the Approvers List
  • Updating Policies
    • Get an Example Request Body for Editing Policy Resources
    • Update the Fields of a Policy
• Requests
  • Check the Progress of a Request
  • Get a Request
  • Get the Localization Policy for the Target Site
  • Get the Owner for the Target Site
  • Get the Query Syntax for Request Resources
  • Get the Repository for the Target Site
  • Get the Site Created by the Request
  • Get the Source Site Associated with the Request
  • Get the Template Associated with the Request
  • Get the User or Application That Created the Request
  • List or Batch Read Site Requests
  • Approvers
    • List Users, Applications or Groups That Can Approve a Request
    • Verify a User, Application or Group Can Approve a Request
  • Delete and Restore
    • Batch Delete Requests
    • Hard Delete a Request
    • Soft Delete a Request
    • Undelete a Soft-Deleted Request
  • Reviews
    • Get a Review
    • Get an Example Request Body for Creating Review Resources
    • Get the Query Syntax for Review Resources
    • Get the User or Application That Created the Review
    • List Reviews Added to a Request
    • Reject or Approve a Request
  • Updating and Retries
    • Get an Example Request Body for Editing Request Resources
    • Retry a Failed Request
    • Update the Fields of a Request
• Settings
  • Get an Example Request Body for Editing Sites Management Settings Resources
  • Get the Site Management Settings
  • Update the Site Management Settings
• Sites
  • Get Default Collection Associated with the Site
  • Get Site Details
  • Get the Channel Associated with the Site
  • Get the Query Syntax for Request Resources
  • Get the Query Syntax for Site Resources
  • Get the Repository Associated with the Site
  • Get the Request That Created the Site
  • Get the Theme Associated With a Site
  • Get the User or Application That Created the Site
  • Get the User or Application That Last Modified the Site
  • Get the User or Application That Owns the Site
  • List or Batch Read Sites
  • List Requests Relating to a Site
  • Content
    • List the Asset Types Used by a Site
    • List the Assets Used by a Site
    • List the Components Used by a Site
  • Content Cache
    • Refresh Content Cache
    • Site Cache Information
    • Site Cache Refresh Status
  • Creating, Updating and Copying
    • Copy a Site
    • Create a Site
    • Create a Template From a Site
    • Get an Example Request Body for Creating Site Resources
    • Get an Example Request Body for Creating Template Resources
    • Get an Example Request Body for Editing Site Resources
    • Update the Fields of a Site
  • Delete and Restore
    • Hard Delete a Site
    • Restore a Soft-Deleted Site
    • Soft Delete a Site
  • Expiration
    • Expire Sites
    • Expire the Site
    • Extend the Expiration Period for a Site
  • Jobs
    • Batch Read the Progress of Site Related Jobs
    • Get the Component Created by a Copy Component Job
    • Get the Details of the Translation File being Imported
    • Get the Details of the Translation File for a Translation Job
    • Get the Details of the Translation Job
    • Get the Progress of a Site Related Job
    • Get the Query Syntax for Site Page Refresh Item Resources
    • Get the Site Created by a Copy Site Job
    • Get the Theme Created by a Copy Theme Job
    • List Pages in a Site Refresh Job
  • Members
    • Batch Unshare Users, Applications or Groups
    • Get an Example Request Body for Creating Site Member Resources
    • Get an Example Request Body for Editing Site Member Resources
    • Get the Group Details for a Member
    • Get the Sharing Role for a User, Application or Group
    • Get the User or Application Details for a Member
    • Leave the Site
    • List the Users, Applications and Groups a Site is Shared With
    • Share a Site with a User, Application or Group
    • Unshare a Site
    • Update the Sharing Role
  • Permissions
    • Get Site Permissions
  • Policies
    • Get the Copy Policy for a Site
    • Get the Expiration Policy for a Site
    • Replace the Copy Policy of a Site
    • Replace the Default Expiration Policy of a Site
  • Publishing and Activation
    • Activate a Site
    • Deactivate a Site
    • Publish Updates to a Site
    • Unpublish a Site
    • Validate the Content of a Site
  • Runtime Access
    • Batch Remove Users, Applications or Groups
    • Get an Access Member
    • Get an Example Request Body for Creating Site Access Member Resources
    • Get the Group Details for a Member
    • Get the User or Application Details for a Member
    • Grant Access to Site
    • List the Users, Applications and Groups with Access
    • Remove an Access Member
  • Translation Jobs
    • Create Translation Job for a Site
    • Import Site Translations
  • Updates
    • Commit Updates to a Site
    • Create a New Site Update
    • Delete a Site Update
    • Get an Example Request Body for Creating Site Update Resources
    • Get the User or Application That Created the Resource
    • Get the User or Application That Last Modified the Resource
    • Get the User or Application That Owns the Resource
    • List The Updates For a Site
  • Vanity Domain
    • Create or Replace the Vanity Domain for a Site
    • Read the Vanity Domain for a Site
    • Remove the Vanity Domain for a Site
• Templates
  • Get Template Details
  • Get the Localization Policy of the Template
  • Get the Query Syntax for Template Resources
  • Get the Theme Associated With a Template
  • Get the User or Application That Created the Template
  • Get the User or Application That Last Modified the Template
  • Get the User or Application That Owns the Site
  • List or Batch Read Templates
  • List the Images of a Template
  • Content
    • List the Asset Types Used by a Template
    • List the Assets Used by a Template
    • List the Components Used by a Template
  • Delete and Restore
    • Hard Delete a Template
    • Restore a Soft-Deleted Template
    • Soft Delete a Template
  • Importing and Exporting
    • Export a Template
    • Get an Example Request Body for Creating Template Resources
    • Import a Template Package
    • Import Default Templates
  • Jobs
    • Batch Read the Progress of Template Related Jobs
    • Get the Progress of a Template Related Job
    • Get the Template Created by an Import Job
    • Get the Theme Created by an Import Job
  • Members
    • Batch Unshare Users, Applications or Groups
    • Get an Example Request Body for Creating Template Member Resources
    • Get an Example Request Body for Editing Template Member Resources
    • Get the Group Details for a Member
    • Get the Sharing Role for a User or Group
    • Get the User or Application Details for a Member
    • Leave the Template
    • List the Users, Applications and Groups a Template is Shared With
    • Share a Template with a User, Application or Group
    • Unshare a Template
    • Update the Sharing Role
  • Permissions
    • Get Template Permissions
  • Policies
    • Associate a Policy with a Template
    • Get an Example Request Body for Creating Policy Resources
    • Get the Site Creation Policy for a Template
    • Unlink the Policy Associated with a Template
  • Updating and Copying
    • Copy a Template
    • Get an Example Request Body for Editing Template Resources
    • Update the Fields of a Template
• Themes
  • Get the Query Syntax for Theme Resources
  • Get the Running Job Associated with the Theme
  • Get the User or Application That Created the Theme
  • Get the User or Application That Last Modified the Theme
  • Get the User or Application That Owns the Theme
  • Get Theme Details
  • List or Batch Read Themes
  • Delete and Restore
    • Hard Delete a Theme
    • Soft Delete a Theme
    • Undelete a Soft-Deleted Theme
  • Members
    • Batch Unshare Users, Applications or Groups
    • Get an Example Request Body for Creating Theme Member Resources
    • Get an Example Request Body for Editing Theme Member Resources
    • Get the Group Details for a Member
    • Get the Sharing Role for a User, Application or Group
    • Get the User or Application Details for a Member
    • Leave the Theme
    • List the Users, Applications and Groups a Theme is Shared With
    • Share a Theme with a User, Application or Group
    • Unshare a Theme
    • Update the Sharing Role
  • Permissions
    • Get Theme Permissions
  • Publishing
    • Publish Updates Made to a Theme
  • Updating and Copying
    • Copy a Theme
    • Get an Example Request Body for Editing Theme Resources
    • Update the Fields of a Theme