> For the complete documentation index, see [llms.txt](https://docs.itconductor.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.itconductor.com/user-guide/setup/api-server-setup.md).
# API Server Setup
### Configure API Server
API Server enables on-premises local access to the IT-Conductor API interface. The Gateway(s) must be configured to act as an API Server.
1. In the IT-Conductor main menu, navigate to **Dashboards → Administrator.**
2. Click the **Gateway** you want to configure to show the metric object menu. Then, click **Modify.**
3. Check the **API Server** checkbox and specify the API Server Port value. Then, click the **Save** icon.
{% hint style="info" %}
**Note:** Ensure the port is available for listening and is not blocked by the local firewall.
{% endhint %}
Within several minutes, the Gateway will start the API server.
### Usage
The IT-Conductor Gateway on Windows includes a client program that can interact with the API server.
The "ITCAPIClient.exe" program can be in the Gateway installation folder "C:\Program Files\IT-Conductor\Agent\bin" and copied to another folder or another Windows computer. There are no external dependencies except Windows .Net Framework 4.5.
The program usages are as follows:
```
C:\Program Files\IT-Conductor\Agent\bin>ITCAPIClient.exe
Usage: -server : -class
Options:
When -class Notify specified:
[-ACTIVITY_QueueId ||]
[-NOTIFY_TargetClass Person|Group|Role|Customer] : ignored if ACTIVITY_QueueId is specified
[-NOTIFY_TargetAttrName PERSON_LoginName|OBJECT_Name] : ignored if ACTIVITY_QueueId is specified
[-NOTIFY_TargetAttrValue ||] : ignored if ACTIVITY_QueueId is specified
-NOTIFY_Subject
-NOTIFY_MessageLong
When -class specified:
Not documented
```
The sample below will create an IT-Conductor Notification for the IT-Conductor user identified by e-mail "". The Notification will send e-mail(s) based on the person's notification schedule.
```
ITCAPIClient ozraid01:8881 -class Notify -NOTIFY_TargetClass Person -NOTIFY_TargetAttrName PERSON_LoginName -NOTIFY_TargetAttrValue admin@itconductor.com -NOTIFY_Subject "Test Message" -NOTIFY_MessageLong "This is a test message sent via API Server"
```
The sample below will create an IT-Conductor notification for the IT-Conductor group BasisAdmins. The Notification will send e-mail(s) to all group members based on their notification schedules.
```
ITCAPIClient ozraid01:8881 -class Notify -NOTIFY_TargetClass Group -NOTIFY_TargetAttrName OBJECT_Name -NOTIFY_TargetAttrValue BasisAdmins -NOTIFY_Subject "Test Message" -NOTIFY_MessageLong "This is a test message sent via API Server"
```
The IT-Conductor Gateway on Linux does not include a client program however, it is possible to use wget similarly:
```
wget http://:/?
Options:
When Class Notify specified:
[ACTIVITY_QueueId=||&]
[NOTIFY_TargetClass=Person|Group|Role|Customer&] : ignored if ACTIVITY_QueueId is specified
[NOTIFY_TargetAttrName=PERSON_LoginName|OBJECT_Name&] : ignored if ACTIVITY_QueueId is specified
[NOTIFY_TargetAttrValue=||&] : ignored if ACTIVITY_QueueId is specified
NOTIFY_Subject=&
NOTIFY_MessageLong=&
When other classes specified:
Not documented
```
For example:
```
wget http://ozraid01:8881/Notify?NOTIFY_TargetClass=Person&NOTIFY_TargetAttrName=PERSON_LoginName&NOTIFY_TargetAttrValue=admin@itconductor.com&NOTIFY_Subject=Test Message&NOTIFY_MessageLong=This is a test message sent via API Server
```
This notation can also be used from any web browser for testing purposes.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.itconductor.com/user-guide/setup/api-server-setup.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.