Sign in
systeminfo

Get general system info

This API is for retrieving general system info, this can be called by anonymous request. Some attributes will be omitted in the response when this API is called by anonymous request.

get/systeminfo

Headers

X-Request-Idstring

An unique ID for the request

Response

Get general info successfully.

banner_messagestring nullable

The banner message for the UI. It is the stringified result of the banner message object.

current_timestring date-time nullable

The current time of the server.

registry_urlstring nullable

The url of registry against which the docker command should be issued.

external_urlstring nullable

The external URL of Harbor, with protocol.

auth_modestring nullable

The auth mode of current Harbor instance.

primary_auth_modeboolean nullable

The flag to indicate whether the current auth mode should consider as a primary one.

project_creation_restrictionstring nullable

Indicate who can create projects, it could be 'adminonly' or 'everyone'.

self_registrationboolean nullable

Indicate whether the Harbor instance enable user to register himself.

has_ca_rootboolean nullable

Indicate whether there is a ca root cert file ready for download in the file system.

harbor_versionstring nullable

The build version of Harbor.

registry_storage_provider_namestring nullable

The storage provider's name of Harbor registry

read_onlyboolean nullable

The flag to indicate whether Harbor is in readonly mode.

notification_enableboolean nullable

The flag to indicate whether notification mechanism is enabled on Harbor instance.

oidc_provider_namestring nullable

The OIDC provider name, empty if current auth is not OIDC_auth or OIDC provider is not configured.

Example response

{
  "banner_message": "{\"closable\":true,\"message\":\"your banner message content\",\"type\":\"warning\",\"fromDate\":\"06/19/2023\",\"toDate\":\"06/21/2023\"}"
}

Changes