POST
/
projects
/
{projectIdOrName}
/
integrations
/
{integrationId}
/
installations

Authorizations

X-Api-Key
string
headerrequired

Path Parameters

projectIdOrName
string
required
integrationId
string
required

Body

application/json
groupRef
string
required

The ID of the user group that has access to this installation.

config
object
required

The config of the installation.

connectionId
string

The ID of the SaaS connection tied to this installation. If omitted the default connection for this group will be used.

Response

201 - application/json
id
string
required

The installation ID.

projectId
string
required

The Ampersand project ID.

integrationId
string
required

The integration ID.

healthStatus
string
required

The health status of the installation ("healthy", "unhealthy").

connection
object
required
createTime
string
required

The time the integration was first installed.

createdBy
string
required

The person who did the installation, in the format of "consumer:{consumer-id}".

config
object
required
group
object
updateTime
string

The time the installation was last updated with a new config.

Was this page helpful?

List installationsImport an existing installation