iModel Connections API is a cloud-based synchronization API meant to synchronize the data in Input Files and iModels. It allows users to establish links from their design files to iModels, hosted in Bentley's iModelHub. Users can synchronize updates to their design files.

synchronization

Synchronization

---

Retrieves the calling user's AuthorizationInformation.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-authorization-information

URL to redirect back to after authorization

redirectUrl

OAuth access token with scope `synchronization:read`

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Retrieves connections for the specified iModel.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-connections

imodelId

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result.

$top

The [$skip](https://www.odata.org/getting-started/basic-tutorial/#topskip) query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

This response indicates that user does not have required permissions to get specified connections.

---

Create a ManifestConnection that describes which files from a manifest will be synchronized to the iModel.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

A connection is linked with an iModel. An iModel ID is required to be set when creating a ManifestConnection.

---


create-manifest-connection

OAuth access token with scope `synchronization:modify`

One or more SourceFiles are already mapped to the iModel.

Invalid request to create connection. Request payload might be missing some of the required properties.

application/json;InvalidManifestConnectionRequest

---

Runs the specified ManifestConnection.

### Notes

When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. 
In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

create-manifest-connection-run

connectionId

Location

This response indicates that an active run is in progress and link is provided in location header.

This response indicates that user does not have required permissions to run specified connection.

This response indicates that the specified connection not found.

A run request is already being processed.

Invalid request to create a connection run.

---

Delete connection

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.


---


delete-manifest-connection

This response indicates that the specified connection was not found.

---

Retrieves a ManifestConnection with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-manifest-connection

This response indicates that user does not have required permissions to get specified connection.

---

Retrieves a ManifestConnection Run with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-manifest-connection-run

runId

This response indicates that user does not have required permissions to get specified connection run.

This response indicates that the specified connection run not found.

---

Add a new Storage Source File to a Storage Connection

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities
SourceFile is added to a Connection. The reuqest path must contain a valid Connection ID

---


add-storage-connection-sourcefile

Storage Connection sourceFile successfully added.

The SourceFile is already mapped to the iModel.

Invalid request to add connection sourcefile. Request payload might be missing some of the required properties.

application/json;InvalidStorageConnectionSourceFileRequest

---

Retrieves StorageConnection's SourceFile with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection-sourcefile

sourceFileId

Invalid request to get connection sourceFile

This response indicates that user does not have required permissions to get specified connection sourceFile.

This response indicates that the specified connection sourceFile not found.

Invalid request to get connection sourcefile.

---

Retrieves SourceFiles for specified StorageConnection.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection-sourcefiles

This response indicates that user does not have required permissions to get specified connection sourceFiles.

Invalid request to get connection sourcefiles.

---

Delete StorageConnection SourceFile

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.


---


remove-storage-connection-sourcefile

This response indicates that one of the associated entities could not be found.

Invalid request to remove connection sourcefile.

---

Update an existing StorageConnection SourceFile.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities
SourceFile is related to a Connection. The path must contain a valid Connection ID.

---


update-storage-connection-sourcefile

Connection sourceFile successfully updated.

Invalid request to update connection sourcefile. Request payload might be missing some of the required properties.

---

Create a StorageConnection that describes files from Storage to synchronize to the iModel.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

A connection is linked with an iModel. An iModel ID is required to be set when creating a StorageConnection.

---


create-storage-connection

application/json;InvalidStorageConnectionRequest

delete-storage-connection

---

Retrieves a StorageConnection with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection

---

Retrieves a StorageConnection Run with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection-run

---

Retrieves all Runs for the specified connection.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection-runs

This response indicates that user does not have required permissions to get specified connection runs.

---

Runs the specified StorageConnection.

### Notes

When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. 
In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

run-storage-connection

---

Update an existing StorageConnection.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

A connection is linked with an iModel. The iModel ID is required to be set when updating a StorageConnection.

---


update-storage-connection

Invalid request to update connection. Request payload might be missing some of the required properties.

Synchronization

API references