Docs Developer Site
Enonic XP
arrow-down
    1. Widgets
  2. IAM
    1. Virtual apps
    1. Projects
    2. Layers
        1. AttachmentUploader
        2. Checkbox
        3. Combobox
        4. ContentSelector
        5. ContentTypeFilter
        6. CustomSelector
        7. Date
        8. DateTime
        9. Double
        10. GeoPoint
        11. HtmlArea
        12. ImageSelector
        13. Long
        14. MediaSelector
        15. Radiobutton
        16. Tag
        17. TextArea
        18. TextLine
        19. Time
      2. Field set
      3. Item set
      4. Option set
      5. Mixins
      6. Localization
    4. Content Types
    5. X-data
    6. Macros
    7. Custom styles
    8. Sites
      1. Regions
      2. Part component
      3. Layout component
      4. Text component
      5. Fragments
      6. Filtering
      7. Component indexing
      8. Visual editor
    10. Page templates
    1. Sandboxes
    2. Code
    3. Building
    4. Configuration
    1. Globals
    2. HTTP
    3. Controllers
    4. Filters
    5. Events
    6. Websocket
    7. Error handler
    8. ID provider
    9. Tasks
    10. Localization
    11. Mappings
    12. Components
    13. Processors
    14. Contributions
    15. Templating
    16. Main controller
    17. Java bridge
      1. Webapp Engine
        1. Image service
        2. Component service
      3. Admin Engine
      4. Asset service
      5. HTTP service
      6. IDprovider service
    2. Task engine
    3. Management Endpoint
    4. Statistics Endpoint
    1. Nodes and repos
    2. Properties
    3. Indexing
    4. Branches
    5. Queries (NoQL)
    6. Queries (DSL)
    7. Filters
    8. Aggregations
    9. Highlighting
    10. Editors
    1. Strategies
    2. Distributions
    3. Docker image
    4. Vhosts
    5. Configuration
    6. Backup & restore
    7. Systemd
    8. Clustering
    1. Admin API
    2. Application API
    3. Auditlog API
    4. Authentication API
    5. Cluster API
    6. Common API
    7. Content API
    8. Context API
    9. Event API
    10. Export API
    11. Grid API
    12. I18N API
    13. IO API
    14. Mail API
    15. Node API
    16. Portal API
    17. Project API
    18. Repo API
    19. Scheduler API
    20. Schema API
    21. Tasks API
    22. Value API
    23. VHost API
    24. Websocket API
  11. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps
Developer Docs Xp Stable Api Lib Admin

Admin API

Contents

This API provides admin-related functions.

Usage

Add the following to your build.gradle file:

dependencies {
  include "com.enonic.xp:lib-admin:${xpVersion}"
}

Add the import statement to your controller:

import adminLib from '/lib/xp/admin';

You are now ready to use the API.

Functions

getAssetsUri

Returns the admin assets uri.

Parameters

None

Returns

string : A URI pointing to the admin assets

getBaseUri

Returns the admin base uri.

Parameters

None

Returns

string : The admin base URI

getHomeToolUrl

Returns the URL for the Home admin tool.

Parameters

An object with the following keys and their values:

Name Kind Details

type

string

Either server (server-relative URL) or absolute

Returns

string : The URL pointing to the Home Tool

getInstallation

Returns installation name.

Parameters

None

Returns

string : The installation name

getLauncherPath

Returns URL to JS script for embedding XP Launcher panel.

Parameters

None

Returns

string : URL of the Launcher JS script

getLauncherUrl

Returns URL of the Launcher panel.

Parameters

None

Returns

string : URL of the Launcher panel

getLocale

Returns the preferred locale based on current HTTP request, or the default server locale if none is specified.

Parameters

None

Returns

string : The preferred locale for this request

getLocales

Returns the list of preferred locales based on current HTTP request, or the default server locale if none is specified.

Parameters

None

Returns

string[] : Current locales in order of preference

getPhrases

Returns all i18n phrases.

Parameters

None

Returns

object : JSON object with phrases

getToolUrl

Returns URL of an admin tool in an application.

Parameters

Name Kind Details

application

string

Full application name (f.ex, 'com.enonic.app')

tool

string

Name of the tool inside an app (f.ex, 'main')

Returns

string : URL of the requested admin tool.

getVersion

Returns version of XP installation.

Parameters

None

Returns

string : The version number of the XP runtime.

Contents

Contents

AI-powered search

Juke AI