Documentation
Documentation
Scope
Close API Documentation
Scope
States
  • Create
    The create state indicates that the Scope is in creation.
  • Active
    The active state indicates that the Scope is active and may be used.
  • Inactive
    The inactive state indicates that the Scope is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Scope is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Domain Name
    The domain name that belongs to the scope.
  • Features
    The list of features that are active in the scope.
  • ID
    A unique identifier for the object.
  • Machine Name
    The name identifying the scope in e.g. URLs.
  • Name
    The name used to identify the scope.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Port
    The port where the scope can be accessed.
  • Preprod Domain Name
    The preprod domain name that belongs to the scope.
  • SSL Active
    Whether the scope supports SSL.
  • Sandbox Domain Name
    The sandbox domain name that belongs to the scope.
  • State
    The object's current state.
  • Themes
    The themes that determine the look and feel of the scope's user interface. A fall-through strategy is applied when building the actual theme.
  • Url
    The URL where the scope can be accessed.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.