Skip to content

Commit 2f5b3d3

Browse files
authored
Merge pull request #181 from ltran-mdb2/DOCSP-45119
DOCSP-45119-REST-API-security
2 parents 68ce03c + 125d65c commit 2f5b3d3

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

source/api-docs.txt

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,21 @@ you access the application on (either ``8278``, ``8080``, or ``443``).
3131
How the REST API Works
3232
----------------------
3333

34-
The Relational Migrator REST API:
34+
The Relational Migrator REST API runs on the client computer or server
35+
that has Relational Migrator installed. By default, Relational Migrator
36+
does not expose the API to any remote computers. If you use the default
37+
security settings, you must make all calls to the API on the same
38+
computer that you are running Relational Migrator on.
3539

36-
- Runs on the client computer or server that the Relation Migrator
37-
application is installed on.
38-
- The Rest API is controlled by the host adapter binding.
39-
- The Relational Migrator REST API **does not** currently support
40-
authentication.
40+
If you want to remotely access the REST API, configure the
41+
``unattended`` profile by :ref:`installing Relational Migrator on an
42+
unattended server <unattended-server>`.
43+
44+
.. warning::
45+
46+
The REST API does not support authentication. If you enable remote
47+
access, users do not need to authenticate to call the API which may
48+
cause security vulnerabilities.
4149

4250
When to Use REST API
4351
--------------------

0 commit comments

Comments
 (0)