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 |
|---|---|---|
|
|
|
|
|
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.
| Name | Type | Description |
|---|---|---|
|
|
Site name from the configuration. For example |
|
|
Comma-separated list of site names. For example |
|
|
Server alias. Can be an IP address, a number, or a full server name from the configuration. For example |
|
|
Comma-separated list of server aliases. For example |
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.
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.
| Name | Description |
|---|---|
|
Name of the site within which the operation is performed. |
|
Name of the node on which the operation is performed. |
|
Server number from the configuration within which the operation is performed. |
|
Server address from the configuration within which the operation is performed. |
|
Activity/availability flag of the node from the web server serving the request.
If the node is available, the operation was performed. |
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.
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.
| Name | Description |
|---|---|
|
Name of the site within which the operation is performed. |
|
Name of the node on which the operation is performed. |
|
Server number from the configuration within which the operation is performed. |
|
Server address from the configuration within which the operation is performed. |
|
Activity/availability flag of the node from the web server serving the request.
If the node is available, the operation was performed. |
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
}
]