HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Attach a git repository and return the public key to register

Attach a git repository (phase 1): validate the config, generate the SSH keypair, persist it, and notify the runners. Returns the PUBLIC key plus a "key_registration" object saying where it must be registered — git is not enabled until it is and /status flips to "connected". key_registration.target is "repository_deploy_key" for GitHub/GitLab/Bitbucket, or "account_ssh_key" for Azure DevOps, which has no per-repository deploy keys: there the key binds to a user identity and inherits everything that account can reach, so key_registration.warning is populated and must be shown. Admin only.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

SSH git remote (git@host:path or ssh://…). http(s) remotes are rejected.

string

One of generic|github|gitlab|azure_devops|bitbucket. Defaults to generic.

string

Default branch name. Defaults to master.

Responses
403

Git as repository is not licensed for this environment

503

The license could not be verified

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!