Global Settings Controller Resource

The API allows you to view and edit global settings.

GET /global-settings

Returns global settings details.

Response Body
media type data type description
application/json GlobalSettingsDetails (JSON) global settings details

Example

Request
GET /global-settings
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "isInstanceIpVisibleInReporting" : true,
  "nodeStatusUpdateInterval" : 12345,
  "removedBackupRetention" : 12345,
  "removedSnapshotRetention" : 12345,
  "taskRetention" : 12345,
  "periodicInventorySyncInterval" : 12345,
  "periodicTapeManagerInventorySyncInterval" : 12345,
  "unmountPeriodForMountedBackups" : 12345,
  "authSettings" : {
    "authLdapEnabled" : true,
    "authLdapUrl" : "...",
    "authLdapBaseDn" : "...",
    "authLdapUserFilter" : "...",
    "authLdapUseTls" : true,
    "authLdapUseSsl" : true,
    "authLdapAnonymousAccessAllowed" : true,
    "authLdapBindDn" : "...",
    "authLdapBindPassword" : "...",
    "authLdapSubtreeSearchEnabled" : true,
    "keycloakEnabled" : true,
    "keycloakServerUrl" : "...",
    "keycloakRealm" : "...",
    "keycloakResource" : "...",
    "keycloakServiceUser" : "...",
    "keycloakServicePassword" : "...",
    "keycloakCert" : "..."
  },
  "emailName" : "...",
  "emailPort" : 12345,
  "emailRequireAuth" : true,
  "emailSmtpServer" : "...",
  "emailSslPort" : 12345,
  "emailUserName" : "...",
  "emailAddress" : "...",
  "emailSendingTime" : 12345,
  "emailFailedBackupsNotification" : true,
  "emailGroupBy" : "HVM",
  "backupRemovalTime" : 12345,
  "snapshotRemovalTime" : 12345,
  "statusReportingSettings" : {
    "statusReportingEnabled" : true,
    "statusReportingLogUploadEnabled" : true,
    "statusReportingBackupInfoEnabled" : true
  },
  "uiSettings" : {
    "uiDefaultPagingSize" : 12345,
    "uiConsoleMode" : "WORKFLOW"
  },
  "emailNotificationSettings" : [ {
    "guid" : "...",
    "type" : "TASK_STATE_CHANGED",
    "active" : true
  }, {
    "guid" : "...",
    "type" : "LOW_DISK_SPACE_ON_PHYSICAL_DEVICE_BY_VDO",
    "active" : true
  } ],
  "sessionTimeout" : 12345,
  "unmountTimeLimit" : 12345,
  "modificationTime" : 1451649601000
}
                
              

PUT /global-settings

Change global settings details.

Request Body
media type data type description
application/json GlobalSettingsRequest (JSON) specify global settings details to update
Response Body
media type data type description
application/json GlobalSettingsDetails (JSON) updated details of global settings

Example

Request
PUT /global-settings
Content-Type: application/json
Accept: application/json

                
{
  "isInstanceIpVisibleInReporting" : true,
  "nodeStatusUpdateInterval" : 12345,
  "removedBackupRetention" : 12345,
  "removedSnapshotRetention" : 12345,
  "taskRetention" : 12345,
  "periodicInventorySyncInterval" : 12345,
  "periodicTapeManagerInventorySyncInterval" : 12345,
  "authSettings" : {
    "authLdapEnabled" : true,
    "authLdapUrl" : "...",
    "authLdapBaseDn" : "...",
    "authLdapUserFilter" : "...",
    "authLdapUseTls" : true,
    "authLdapUseSsl" : true,
    "authLdapAnonymousAccessAllowed" : true,
    "authLdapBindDn" : "...",
    "authLdapBindPassword" : "...",
    "authLdapSubtreeSearchEnabled" : true,
    "authLdapGroups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "keycloakEnabled" : true,
    "keycloakServerUrl" : "...",
    "keycloakRealm" : "...",
    "keycloakResource" : "...",
    "keycloakSecret" : "...",
    "keycloakServiceUser" : "...",
    "keycloakServicePassword" : "...",
    "keycloakCert" : "...",
    "keycloakGroups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ]
  },
  "emailName" : "...",
  "emailPort" : 12345,
  "emailRequireAuth" : true,
  "emailSmtpServer" : "...",
  "emailSslPort" : 12345,
  "emailUserName" : "...",
  "emailAddress" : "...",
  "emailSendingTime" : 12345,
  "backupRemovalTime" : 12345,
  "emailFailedBackupsNotification" : true,
  "emailGroupBy" : "HV",
  "snapshotRemovalTime" : 12345,
  "statusReportingSettings" : {
    "statusReportingEnabled" : true,
    "statusReportingLogUploadEnabled" : true,
    "statusReportingBackupInfoEnabled" : true
  },
  "uiSettings" : {
    "uiDefaultPagingSize" : 12345,
    "uiConsoleMode" : "WORKFLOW"
  },
  "emailNotificationSettings" : [ {
    "guid" : "...",
    "type" : "TASK_STATE_CHANGED",
    "active" : true
  }, {
    "guid" : "...",
    "type" : "NODE_STATE_CHANGED",
    "active" : true
  } ],
  "sessionTimeout" : 12345,
  "unmountTimeLimit" : 12345,
  "unmountPeriodForMountedBackups" : 12345
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "isInstanceIpVisibleInReporting" : true,
  "nodeStatusUpdateInterval" : 12345,
  "removedBackupRetention" : 12345,
  "removedSnapshotRetention" : 12345,
  "taskRetention" : 12345,
  "periodicInventorySyncInterval" : 12345,
  "periodicTapeManagerInventorySyncInterval" : 12345,
  "unmountPeriodForMountedBackups" : 12345,
  "authSettings" : {
    "authLdapEnabled" : true,
    "authLdapUrl" : "...",
    "authLdapBaseDn" : "...",
    "authLdapUserFilter" : "...",
    "authLdapUseTls" : true,
    "authLdapUseSsl" : true,
    "authLdapAnonymousAccessAllowed" : true,
    "authLdapBindDn" : "...",
    "authLdapBindPassword" : "...",
    "authLdapSubtreeSearchEnabled" : true,
    "keycloakEnabled" : true,
    "keycloakServerUrl" : "...",
    "keycloakRealm" : "...",
    "keycloakResource" : "...",
    "keycloakServiceUser" : "...",
    "keycloakServicePassword" : "...",
    "keycloakCert" : "..."
  },
  "emailName" : "...",
  "emailPort" : 12345,
  "emailRequireAuth" : true,
  "emailSmtpServer" : "...",
  "emailSslPort" : 12345,
  "emailUserName" : "...",
  "emailAddress" : "...",
  "emailSendingTime" : 12345,
  "emailFailedBackupsNotification" : true,
  "emailGroupBy" : "DATACENTER",
  "backupRemovalTime" : 12345,
  "snapshotRemovalTime" : 12345,
  "statusReportingSettings" : {
    "statusReportingEnabled" : true,
    "statusReportingLogUploadEnabled" : true,
    "statusReportingBackupInfoEnabled" : true
  },
  "uiSettings" : {
    "uiDefaultPagingSize" : 12345,
    "uiConsoleMode" : "WORKFLOW"
  },
  "emailNotificationSettings" : [ {
    "guid" : "...",
    "type" : "TASK_STATE_CHANGED",
    "active" : true
  }, {
    "guid" : "...",
    "type" : "TASK_STATE_CHANGED",
    "active" : true
  } ],
  "sessionTimeout" : 12345,
  "unmountTimeLimit" : 12345,
  "modificationTime" : 1451649601000
}
                
              

GET /global-settings/authentication-type

Response Body
media type data type description
application/json AuthenticationType (JSON)

Example

Request
GET /global-settings/authentication-type
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "source" : "LDAP",
  "keycloakServerUrl" : "...",
  "keycloakRealm" : "...",
  "keycloakResource" : "..."
}
                
              

GET /global-settings/email-recipients

Response Body
media type data type description
application/json array of string (JSON)

Example

Request
GET /global-settings/email-recipients
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /global-settings/unmount

Returns global settings details for restore.

Response Body
media type data type description
application/json GlobalSettingsMountDetails (JSON) global settings details for restore

Example

Request
GET /global-settings/unmount
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "unmountPeriodForMountedBackups" : 12345,
  "unmountTimeLimit" : 12345
}
                
              

PUT /global-settings/email/password

Change password for email.

Request Body
media type data type description
application/json StringDTO (JSON) specify password for email

Example

Request
PUT /global-settings/email/password
Content-Type: application/json

                
{
  "value" : "..."
}
                
              
Response
HTTP/1.1 204 No Content

              

POST /global-settings/email/test

Send test email.

Example

Request
POST /global-settings/email/test
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 201 Created

              

PUT /global-settings/keycloak/auth-settings

Request Body
media type data type
application/json KeycloakAuthSettings (JSON)
Response Body
media type data type description
application/json DecodedCertificate (JSON)

Example

Request
PUT /global-settings/keycloak/auth-settings
Content-Type: application/json
Accept: application/json

                
{
  "keycloakServerUrl" : "...",
  "keycloakRealm" : "...",
  "keycloakResource" : "...",
  "keycloakSecret" : "...",
  "groupIds" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "type" : "...",
  "notAfter" : 12345,
  "notBefore" : 12345,
  "issuer" : "...",
  "subject" : "...",
  "alg" : "...",
  "serialNumber" : 12345,
  "publicKey" : "..."
}
                
              

GET /global-settings/keycloak/refresh

Response Body
media type data type description
application/json DecodedCertificate (JSON)

Example

Request
GET /global-settings/keycloak/refresh
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "type" : "...",
  "notAfter" : 12345,
  "notBefore" : 12345,
  "issuer" : "...",
  "subject" : "...",
  "alg" : "...",
  "serialNumber" : 12345,
  "publicKey" : "..."
}
                
              

PUT /global-settings/keycloak/secret

Change keycloak client secret

Request Body
media type data type description
application/json StringDTO (JSON) specify keycloak client secret

Example

Request
PUT /global-settings/keycloak/secret
Content-Type: application/json

                
{
  "value" : "..."
}
                
              
Response
HTTP/1.1 204 No Content