Skip to main content
POST
Connect a repository and deploy

Autorisations

Authorization
string
header
requis

API token (olab_…) created in Settings → API tokens or with orbitlab login.

En-têtes

X-OrbitLab-Org
string

Organization to act on (id or slug) for tokens that can access several organizations. Defaults to your first organization.

Paramètres de chemin

id
string
requis

Service id.

Corps

application/json
name
string
requis

Project name: lowercase letters, digits and hyphens (min 3).

repoUrl
string
requis

HTTPS URL on github.com, gitlab.com or bitbucket.org.

branch
string

Production branch. Defaults to main.

rootDir
string

App directory inside the repository (monorepos).

buildCmd
string

Build command.

startCmd
string

Start command.

envVars
object

Map of variable name to value.

githubInstallationId
integer

GitHub App installation for private repositories.

githubRepoId
integer

GitHub repository id.

githubRepoOwner
string

GitHub repository owner.

githubRepoName
string

GitHub repository name.

Réponse

success and serviceId.

The response is of type object.