Connected repositories

What can be connected#

GitHub and GitLab availability on this platform.

Response

Errors

Example

curl "https://api.ibel.ai/v1/repos/config" \
  -H "Authorization: Bearer $KEY"

The team's Git connections#

Response

Errors

Example

curl "https://api.ibel.ai/v1/repos/connections" \
  -H "Authorization: Bearer $KEY"

Start connecting GitHub or GitLab#

Returns the address to open and approve.

Request bodyapplication/json

• providerstringrequired

  one of github, gitlab

• hoststring

  GitLab only: a self-hosted GitLab's https address

• application_idstring
• secretstring

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/repos/connections" \
  -H "Authorization: Bearer $KEY" \
  -d '{"provider":"github"}'

Finish connecting GitHub or GitLab#

Called by the dashboard when the browser comes back from the Git host with ?finish=<ticket>. Only the person who began the connection, in the team it was begun for, can finish it, once.

Request bodyapplication/json

• ticketstringrequired

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/repos/connections/finish" \
  -H "Authorization: Bearer $KEY" \
  -d '{"ticket":"…"}'

Remove a Git connection#

Parameters

• idstring (uuid)pathrequired
• unlinkbooleanquery

  also unlink the projects that use it

Response

Errors

Example

curl -X DELETE "https://api.ibel.ai/v1/repos/connections/88e2fe1d-6d75-4de5-8c8f-27380ec66903" \
  -H "Authorization: Bearer $KEY"

Repositories a connection can reach#

Parameters

• idstring (uuid)pathrequired
• qstringquery

  part of a repository name

Response

Errors

Example

curl "https://api.ibel.ai/v1/repos/connections/88e2fe1d-6d75-4de5-8c8f-27380ec66903/repositories" \
  -H "Authorization: Bearer $KEY"

Make a project from a repository#

Creates the project, links it and builds the production branch.

Request bodyapplication/json

• namestringrequired
• kindstring

  one of app, function

• connectionstringrequired
• repostringrequired

  the repository's id from the repositories list

• production_branchstring
• previewsboolean

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/repos/import" \
  -H "Authorization: Bearer $KEY" \
  -d '{"name":"my-api","connection":"…","repo":"…"}'

The repository a project is built from#

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl "https://api.ibel.ai/v1/apps/my-api/repo" \
  -H "Authorization: Bearer $KEY"

Link a project to a repository#

Replaces an earlier link. GitLab: adds a webhook to the project.

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

• connectionstringrequired
• repostringrequired
• production_branchstring
• previewsboolean

Response

Errors

Example

curl -X PUT "https://api.ibel.ai/v1/apps/my-api/repo" \
  -H "Authorization: Bearer $KEY" \
  -d '{"connection":"…","repo":"…"}'

Stop building a project from its repository#

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl -X DELETE "https://api.ibel.ai/v1/apps/my-api/repo" \
  -H "Authorization: Bearer $KEY"

Build a branch of the linked repository now#

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

• branchstring

  default: the production branch

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/apps/my-api/repo/builds" \
  -H "Authorization: Bearer $KEY" \
  -d '{"branch":"dev"}'

The repository a project is built from#

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl "https://api.ibel.ai/v1/functions/my-api/repo" \
  -H "Authorization: Bearer $KEY"

Link a project to a repository#

Replaces an earlier link. GitLab: adds a webhook to the project.

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

• connectionstringrequired
• repostringrequired
• production_branchstring
• previewsboolean

Response

Errors

Example

curl -X PUT "https://api.ibel.ai/v1/functions/my-api/repo" \
  -H "Authorization: Bearer $KEY" \
  -d '{"connection":"…","repo":"…"}'

Stop building a project from its repository#

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl -X DELETE "https://api.ibel.ai/v1/functions/my-api/repo" \
  -H "Authorization: Bearer $KEY"

Build a branch of the linked repository now#

Parameters

• namestringpathrequired

  the function's or app's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

• branchstring

  default: the production branch

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/functions/my-api/repo/builds" \
  -H "Authorization: Bearer $KEY" \
  -d '{"branch":"dev"}'

Webhook from GitHub#

Called by GitHub; verified by X-Hub-Signature-256 (HMAC-SHA256 of the raw body). Roles: none (signature).

Parameters

• X-Hub-Signature-256stringheaderrequired

  sha256=<hex>

• X-GitHub-Eventstringheaderrequired

  the event type

Request bodyapplication/json

object

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/repos/webhooks/github" \
  -d '{}'

Webhook from GitLab#

Called by GitLab; verified by X-Gitlab-Token, one secret per linked project. Roles: none (token).

Parameters

• linkstring (uuid)pathrequired
• X-Gitlab-Tokenstringheaderrequired

  the project's hook secret

• X-Gitlab-Eventstringheaderrequired

  Push Hook or Merge Request Hook

Request bodyapplication/json

object

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/repos/webhooks/gitlab/link" \
  -d '{}'

Return from Github's approval page#

Connects nothing itself: redirects to the dashboard's Settings → Git with a one-time finish=<ticket> (finished there with the person's session, POST /v1/repos/connections/finish) or error=<code>. Roles: none (signed state).

Response

Errors

Example

curl "https://api.ibel.ai/v1/repos/callback/github"

Return from Gitlab's approval page#

Connects nothing itself: redirects to the dashboard's Settings → Git with a one-time finish=<ticket> (finished there with the person's session, POST /v1/repos/connections/finish) or error=<code>. Roles: none (signed state).

Response

Errors

Example

curl "https://api.ibel.ai/v1/repos/callback/gitlab"