Add a new app

POST /apps/register

Add a new app to Bitrise. This is the first step of the app registration process. To successfully set it up, you need to provide the required app parameters: the repository URL and the isPublic field. Read more about the app creation process in our detailed guide.

Body Required

App parameters

default_branch_name string

The default branch of the repository. If it's not specified, it will be master.
git_owner string

[Deprecated] You no longer need to provide this field.
git_repo_slug string

[Deprecated] You no longer need to provide this field.
is_public boolean Required

If true then the repository visibility setting will be public, in case of false it will be private
manual_approval_enabled boolean

Toggles whether manual approval should be enabled for the app's builds. If it's not specified, it will be true.
organization_slug string

The slug of the organization, who will be the owner of the application. If it's not specified, then the authenticated user will be the owner.
provider string

The git provider you are using, it can be github, bitbucket, gitlab, gitlab-self-hosted or custom
repo_url string Required

The URL of your repository
title string

The title of the application. If it's not specified, it will be the git repository's name.
type string

[Deprecated] You no longer need to provide this field.

Responses

200

OK
Hide response attributes Show response attributes object
- slug string
- status string
400

Bad Request
Hide response attribute Show response attribute object
- error_msg string
401

Unauthorized
Hide response attribute Show response attribute object
- error_msg string
404

Not Found
Hide response attribute Show response attribute object
- error_msg string
500

Internal Server Error
Hide response attribute Show response attribute object
- error_msg string

POST /apps/register

curl \
 --request POST 'https://api.bitrise.io/v0.1/apps/register' \
 --header "Authorization: $API_KEY" \
 --data '{"default_branch_name":"string","git_owner":"string","git_repo_slug":"string","is_public":true,"manual_approval_enabled":true,"organization_slug":"string","provider":"string","repo_url":"string","title":"string","type":"string"}'

Request examples

{
  "default_branch_name": "string",
  "git_owner": "string",
  "git_repo_slug": "string",
  "is_public": true,
  "manual_approval_enabled": true,
  "organization_slug": "string",
  "provider": "string",
  "repo_url": "string",
  "title": "string",
  "type": "string"
}

Response examples (200)

{
  "slug": "string",
  "status": "string"
}

Response examples (400)

{
  "error_msg": "string"
}

Response examples (401)

{
  "error_msg": "string"
}

Response examples (404)

{
  "error_msg": "string"
}

Response examples (500)

{
  "error_msg": "string"
}