---
title: "Create a new integration"
method: POST
path: "/integrations"
tags: ["Integrations"]
---

# Create a new integration

`POST /integrations`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/integrations`
- Auth: none declared

Creates a new integration in Itential Platform.

## Request body

- object
  - `properties` IntegrationsPostRequestBodyContentApplicationJsonSchema
    - `loggerProps` IapServicesSchemaLoggerProps
      - `description` string: The description property
      - `log_directory` string, required: The directory to store Pronghorn log files.
      - `log_filename` string, required: The name of the current Pronghorn log file.
      - `log_max_file_size` integer, required: The maximum size of each Pronghorn log file in bytes.
      - `log_max_files` integer, required: The maximum number of log files maintained on the server.
      - `log_timezone_offset` integer: An integer specifying the offset from GMT/UTC time that will be used when writing to the log files.
      - `log_level` 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'spam', required
      - `console_level` 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'spam', required
      - `metrics_filename` string: The name of the job metrics log file, if applicable.
      - `metrics_max_files` integer: The maximum number of job metrics log files maintained on the server, if applicable.
      - `metrics_rotation_interval` string: The time until the metrics log is rotated in minutes, hours, days, or weeks, if applicable.
      - `metrics_rotation_size` string: The maximum file size before the metrics log is rotated in kilobytes, megabytes, or gigabytes, if applicable.
      - `syslog` IapServicesSchemaLoggerPropsSyslog: The syslog properties allow Pronghorn to send log messages to a local or remote syslog daemon.
        - `level` 'debug' | 'info' | 'warning' | 'error'
        - `host` string: The host running syslogd.
        - `port` integer: The port on the host that syslog is running on.
        - `protocol` 'tcp4' | 'udp4' | 'unix' | 'unix-connect': The network protocol to log over. Can be one of tcp4, udp4, unix or unix-connect.
        - `facility` string: Syslog facility to use.
        - `type` 'BSD' | '5424': The type of syslog protocol to use. Possible values are BSD and 5424.
        - `path` string, uri-reference: The path to the syslog dgram socket (i.e. /dev/log or /var/run/syslog for OS X).If path is used, host, port and protocol do not need to be configured.
        - `pid` string: Process identifier (PID) of the process that log messages are coming from (Default is process.pid).
        - `localhost` string: Host to indicate that log messages are coming from.
        - `app_name` string: The name of the application.
        - `eol` string: The end of line character to be added to the end of the message.
    - `isEncrypted` boolean: Whether or not this service is encrypted
    - `model` string: The model used by the service
    - `name` string, required: The name of the service
    - `type` 'Application' | 'Adapter', required: If the service is an app or adapter
    - `description` string: A user-defined description of this integration instance.
    - `properties` IapServicesSchemaProperties, required: The properties of a service
    - `virtual` boolean, required: Whether or not this service is an Integration.

## Response `200`

The result of the integration creation process.

- IntegrationsCreateIntegrationResponse200
  - `status` 'OK' | 'Created': The status of the API request.
  - `message` string: Message containing either confirmation of the operation or the reason for the failure of the operation.
  - `data` union: All of the properties required for a service.
    - IapServicesSchema0
      - `type` unknown
      - `properties` IapServicesSchemaOneOf0
    - IapServicesSchema1
      - `type` unknown
      - `properties` IapServicesSchemaOneOf1
        - `id` string, required: The id for the service
        - `type` string, required: The type of service
        - `properties` IapServicesSchemaOneOf1, required (recursive)
        - `brokers` IapServicesSchemaOneOf1BrokersItems[], required: Brokers which utilize this service
        - `groups` string[], required: Groups which can use this service

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)