---
title: "Install an Integration"
method: POST
path: "/integrations/install/{name}"
tags: ["Integrations"]
---

# Install an Integration

`POST /integrations/install/{name}`

## Path parameters

- `name` string, required

## Request body

- InstallIntegrationRequestBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `attributes` InstallIntegrationRequestAttributes, required
    - `config` object, required

## Response `200`

OK

- InstallIntegrationResponseBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `data` IntegrationInstallation, required
    - `attributes` IntegrationInstallationAttributes, required
      - `capabilities` string[], required
      - `displayName` string, required
      - `externalRef` string, required
      - `integrationName` string, required
      - `providerName` string, required
      - `sanitizedConfig` object, required
      - `userSettings` object, required
    - `id` string, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

## Changes

- **2026-07-29** (v1) `227f4f2711e4` — 1 info
  - added the required property `data/attributes/capabilities` to the response with the `200` status
- **2026-07-07** (v1) `48f07aa81a7a` — 2 breaking, 1 warning, 2 info
  - removed the required property `data/attributes/config` from the response with the `200` status
  - removed the required property `data/attributes/settings` from the response with the `200` status
  - removed the request property `attributes/userSettings`
  - added the required property `data/attributes/sanitizedConfig` to the response with the `200` status
  - …1 more
- **2026-06-24** (v1) `eb0846e58abc` — 3 breaking, 2 info
  - added the new required request property `attributes/userSettings`
  - removed the required property `data/attributes/sanitizedConfig` from the response with the `200` status
  - removed the required property `data/attributes/userSettings` from the response with the `200` status
  - added the required property `data/attributes/config` to the response with the `200` status
  - …1 more

[Change history](https://skmtc.dev/rezible/apis/rezible-api/changes/integrations/install/:name/post.md)

---

[API](https://skmtc.dev/rezible/apis/rezible-api.md) · [All operations](https://skmtc.dev/rezible/apis/rezible-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rezible/rezible-api/revisions/eaee3040e50d/schema)