Skip to main content
PUT
Connect a GitHub repository

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Path Parameters

destinationId
string<uuid>
required
Example:

"a3bb189e-8bf9-4888-9912-ace4e6543002"

Body

application/json
owner
string
required
Minimum string length: 1
Example:

"acme"

name
string
required
Minimum string length: 1
Example:

"website"

baseBranch
string
required
Minimum string length: 1
Example:

"main"

contentRoot
string
required

The folder articles live in.

Minimum string length: 1
Example:

"content/blog"

publicRoutePattern
string
required

The address an article is published at, with {slug} where its slug goes.

Minimum string length: 1
Example:

"https://example.com/blog/{slug}"

Response

The stored configuration.

destinationId
string
required
repository
string
required
Example:

"acme/website"

baseBranch
string
required
contentRoot
string
required
publicRoutePattern
string
required
fileExtension
string
required
requiredFrontmatter
string[]
required