Root certificate management

Overview

Provides access to methods for updating root certificates from disk (on all nodes). Root certificates are used for client verification of certificate authenticity in TLS connections.

Requests

HTTP verb Endpoint Description

RELOAD

/rest/v1/master/logicalroles/all/cacerts

Loading root certificates from disk

CLEAR

/rest/v1/master/logicalroles/all/cacerts

Clearing root certificates

Common request scope parameters

The parameters below are used in the URL (?param=value) to limit the request application scope (the set of role instances to which the request applies). All are optional and may be absent. It makes sense to specify no more than one of them, or none at all.

Table 1. Possible parameters
Name Type Description

site

str

Site name from the configuration.

For example SITE8.

sites

array<str>

Comma-separated list of site names.

For example SITE1,SITE3.

server

str

Server alias. Can be an IP address, a number, or a full server name from the configuration.

For example 192.168.0.12 or 372.

servers

array<str>

Comma-separated list of server aliases.

For example 192.168.0.12,372,server05.


Loading root certificates from disk

Performs loading from disk into node memory of all root certificates. These are the standard paths:

  • /usr/local/share/ca-certificates - the standard directory for placing root certificates inside the container, independent on all servers.

  • :SYNC/common/cacerts - the platform directory synchronized between all servers, available from the host as a Docker volume.

The request is parallelized for execution on all nodes within the scope specified by URL parameters.

The composition of root certificates in the :SYNC/common/cacerts folder can also be managed using the master domain REST API: /rest/v1/fs/targets/cacerts.

Request

The URL may contain additional scope parameters.

Example request
RELOAD /rest/v1/master/logicalroles/all/cacerts HTTP/1.1

Response

Contains a list of representation objects of all node instances within the request scope. Each object contains the status and result of the request execution.

Table 2. Object fields
Name Description

site

Name of the site within which the operation is performed.

node

Name of the node on which the operation is performed.

srvidx

Server number from the configuration within which the operation is performed.

addr

Server address from the configuration within which the operation is performed.

online

Activity/availability flag of the node from the web server serving the request.

  • true – the node is available and active.

  • false – the node is unavailable.

If the node is available, the operation was performed.

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "site": "main_site",
    "node": "mic@172.27.1.112",
    "srvidx": 0,
    "addr": "172.27.1.112",
    "online": true
  },
  {
    "site": "main_site",
    "node": "ic1@172.27.1.112",
    "srvidx": 0,
    "addr": "172.27.1.112",
    "online": true
  },
  {
    "site": "main_site",
    "node": "sg1@172.27.1.112",
    "srvidx": 1007,
    "addr": "172.27.1.112",
    "online": true
  }
]

Clearing root certificates

Performs unloading from memory of all root certificates.

The request is parallelized for execution on all nodes within the scope specified by URL parameters.

Request

The URL may contain additional scope parameters.

Example request
CLEAR /rest/v1/master/logicalroles/all/cacerts HTTP/1.1

Response

Contains a list of representation objects of all node instances within the request scope. Each object contains the status and result of the request execution.

Table 3. Object fields
Name Description

site

Name of the site within which the operation is performed.

node

Name of the node on which the operation is performed.

srvidx

Server number from the configuration within which the operation is performed.

addr

Server address from the configuration within which the operation is performed.

online

Activity/availability flag of the node from the web server serving the request.

  • true – the node is available and active.

  • false – the node is unavailable.

If the node is available, the operation was performed.

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "site": "main_site",
    "node": "mic@172.27.1.112",
    "srvidx": 0,
    "addr": "172.27.1.112",
    "online": true
  },
  {
    "site": "main_site",
    "node": "ic1@172.27.1.112",
    "srvidx": 0,
    "addr": "172.27.1.112",
    "online": true
  },
  {
    "site": "main_site",
    "node": "sg1@172.27.1.112",
    "srvidx": 1007,
    "addr": "172.27.1.112",
    "online": true
  }
]