Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update API Docs.rst #141

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update API Docs.rst #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Developer Documentation/API Docs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ HTTP Access

Access to the HTTP API is restricted to valid API keys. An :code:`X-API-Key` HTTP header must be sent to indicate which API key is to be used with the request. The API key must match the remote IP of the connected HTTP client. The remote IP is checked as usual. If the osTicket server is sitting behind a reverse proxy, the original IP of the client will be retrieved from the :code:`X-Forwarded-For` header, if provided by your proxy.

Example:
**Example:**

.. code-block:: bash

X-API-Key: BA00B76BAA30F62E1940B46CC1C3C73C


Commandline Example with Curl:
**Command Line example with Curl:**

.. code-block:: bash

Expand Down