Install an integration on a site

post

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

installationIdstringRequired

Identifier of the installation

Query parameters

extendedbooleanOptional

If true, returns the site object in each items. If false, returns the site ID in each items.

Default: false

Body

application/json

siteIdstringRequired

ID of the site to install the integration on

Responses

201

Integration installed successfully on site

application/json

404

Not Found

application/json

post/integrations/{integrationName}/installations/{installationId}/sites

HTTPcURLJavaScriptPython

POST /v1/integrations/{integrationName}/installations/{installationId}/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "siteId": "text"
}

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com",
    "publicContentEndpoint": "https://example.com"
  },
  "site": "text"
}