Skip to main content
POST
Add a content source

Authorizations

Authorization
string
header
required

API key with dtk_live_ prefix. Obtain it from API Keys in the account sidebar. New keys start with all supported scopes selected for the chosen project, and you can narrow them to specific read/write scopes as needed.

Path Parameters

projectId
string<uuid>
required

The project the credential is bound to. Read it from GET /connection.

Body

application/json
provider
string
required
Allowed value: "github"
urlPrefix
string
required

The site address the source covers: a host and path such as docs.example.com/ or example.com/blog/. A scheme, query and fragment are dropped; the path is made to end in a slash.

Required string length: 1 - 600
installationId
string<uuid>
required

A GitHub installation id from getContentSources githubInstallations.

repositoryId
integer
required

A repository id listContentRepositories lists for the installation.

Required range: x >= 1
branch
string

The branch pull requests target. Defaults to the repository's default branch.

Maximum string length: 255
folder
string

The folder that holds the pages under urlPrefix, such as docs. Defaults to the repository root.

Maximum string length: 500

Response

The added source

data
object
required
meta
object
required

Sent beside data on every successful response that returns data.