7.2.1.7. Dashboard Info API

Endpoints

GET

/

DEPRECATED Use /api instead. Main Dashboard API endpoint

GET

/api

Main Dashboard API endpoint

GET

/api/check_credentials

Can be used to validate credentials
GET /

Use /api instead. Main Dashboard API endpoint.

Deprecated since 7.2.0.

Status Codes:
GET /api

Main Dashboard API endpoint.

Since: 7.2.0

Provides Dashboard meta information and a list of visible projects.

Parameters:

  • exclude_project_info – query

    Whether to exclude project information from the response data. This defaults to false for compatibility reasons; however, clients are advised to set this to true if the data is not needed in order to enhance request performance and to save server resources.

Status Codes:
GET /api/check_credentials

Can be used to validate credentials.

Since: 7.2.0

Intended for credentials and basic access check.

Status Codes:

  • 200 OK –

    Body Type: string

    Successful response has value “ok” and indicates, that the credentials are valid and grant at least the permissions necessary for logging in to the Dashboard.

Types

DashboardInfo

Main API endpoint response

ProjectReference

A reference to a project
DashboardInfo

Main API endpoint response.

Properties:

  • mainUrl (string) Since 7.4.0. The complete dashboard base URL.

    Use this to point your browser to the Dashboard or combine it with the other host-relative URLs returned by this API in order to get complete URLs.

    Note, that this URL may be different from the URL you are currently accessing the Dashboard with for various reasons.

    Also note, that the Dashboard cannot always know the proper value to return here, e.g. when running behind a proxy. So an administrator might need to help out the Dashboard by configuring the proper value in the global settings.

  • dashboardVersion (string) Axivion Dashboard version serving this API.

  • dashboardVersionNumber (string) Since 6.6.0. Parseable Axivion Dashboard Version.

  • dashboardBuildDate (string) Dashboard Server Build date.

  • username (string) Name of the successfully authenticated user if a dashboard-user is associated with the request.

  • csrfTokenHeader (string) DEPRECATED. The HTTP-Request Header expected present for all HTTP requests that are not GET, HEAD, OPTIONS or TRACE.

    Deprecated since 7.6.6: the header name is always AX-CSRF-Token.

  • csrfToken (string) The value expected to be sent along the csrfTokenHeader for all HTTP requests that are not GET, HEAD, OPTIONS or TRACE.

    Note, that this does not replace authentication of subsequent requests. Also the token is combined with the authentication data, so will not work when authenticating as another user. Its lifetime is limited, so when creating a very long-running application you should consider refreshing this token from time to time.

  • checkCredentialsUrl (string) Since 6.5.4. An URI that can be used to check credentials via GET. It returns “ok” in case of valid credentials.

  • namedFiltersUrl (string) Since 7.3.0. Endpoint for managing global named filters

  • projects (array) Element Type: ProjectReference. List of references to the projects visible to the authenticated user.

  • userApiTokenUrl (string) Since 7.1.0. Endpoint for creating and listing api tokens of the current user

  • userNamedFiltersUrl (string) Since 7.3.0. Endpoint for managing custom named filters of the current user

  • supportAddress (string) Since 7.4.3. Email address for support requests

  • issueFilterHelp (string) Since 7.4.3. A host-relative URL that can be used to display filter-help meant for humans.

  • csrfTokenUrl (string) Since 7.6.6. Endpoint for creating new CSRF tokens.

ProjectReference

A reference to a project.

Properties:

  • name (string) The name of the project. Use this string to refer to the project.

  • url (string) URI to get further information about the project.