---
title: "Connection REST API"
slug: "connection-rest-api"
abstract: "Describes the object attributes used in the Sitecore Personalize Connection REST API."
---
# Connection REST API

The Connection REST API enables you to connect Sitecore Personalize to external services.

Use the following attributes for connection objects:

| Attribute | Type | Description | Example(s) |
| --- | --- | --- | --- |
| `items` | JSON array of JSON objects | The array of connections. | N/A |
| `name` | string | The name of the connection. | `"Connect to Data System"` |
| `description` | string | The connection description. | `"custom connection to weather system"` |
| `modifiedByUserRef` | string | The unique reference of the user who modified the connection. | `"843c775e-db9c-49f6-9f56-e3999123bcf4"` |
| `revision` | integer | The sequential number of the connection revision. | `2` |
| `archived` | boolean | The archive status of the connection. | `true, false` |
| `auth` | JSON array of JSON objects | An array of authentication attributes to connect to the service. | N/A |
| `authType` | string | The authentication type required to authenticate requests to the external model. | `"oauth"` |
| `clientId` | string | The secret client ID required to connect to the external model. | `"secretclientid"` |
| `accessTokenUrl` | string | The URL of the access token generated by the external model. The access token URL must use an `https://` URL. | `"https://mockserver-proxy-dev.sitecore.com/oauth/token"` |
| `request` | JSON array of strings | An array of request attributes to connect to the service. | N/A |
| `requestType` | string | The method type of the request. | `"GET"` |
| `connectionUrl` | string | The URL of the connection. | `"https://mockserver-proxy-dev.sitecore.com/sample/get/oauth"` |
| `inputMappings` | JSON array of JSON objects | An array of input mappings to define the input to the web service. | N/A |
| `outputMappings` | JSON array of JSON objects | An array of output mappings to define the output from the web service. | N/A |
| `customHeaders` | JSON array of JSON objects | A JSON array of custom headers to pass to the connection. | N/A |
| `systemType` | string | The type of system you are connecting. | `"DATA_SYSTEM"` |
| `connectionTimeout` | integer | The number of milliseconds that must lapse before the connection times out. | `1000` |
| `socketTimeout` | integer | The number of milliseconds that must lapse before the socket times out while waiting for individual packets. | `1000` |
| `icon` | string | The path to the image file that contains the icon representing the connection in the UI. | `"assets/images/icons/connections/plug.svg"` |