Skip to content

Commit 634bf8f

Browse files
committed
DOCSP-45119-REST-API-security
1 parent 68ce03c commit 634bf8f

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+
on which you install Relational Migrator. By default, Relational
36+
Migrator does not expose the API to any remote computers. You must make
37+
all calls to API on the same computer that you are running Relational
38+
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 use an
47+
``unattended`` profile, users do not need to authenticate to call the
48+
API. Using remote access may cause security vulnterabilities.
4149

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

0 commit comments

Comments
 (0)