Save the application at the end of the app registration process

POST /apps/{app-slug}/finish

Save the application after registering it on Bitrise and registering an SSH key (and, optionally, adding a webhook). With this endpoint you can define the initial configuration, define application-level environment variables, determine the project type, and set an Organization to be the owner of the app. Read more about the app registration process in our detailed guide.

Path parameters

  • app-slug string Required

    App slug

Body Required

App finish parameters

  • config string

    Which config to use. Specify a config that matches your project type (e. g. default-android-config for android, etc.). If not speficied, default value is other-config. The available values are default-android-config, default-cordova-config, default-fastlane-android-config, default-fastlane-ios-config, flutter-config-notest-app-android, flutter-config-notest-app-both, flutter-config-notest-app-ios, flutter-config-test-app-android, flutter-config-test-app-both, flutter-config-test-app-ios, default-ionic-config, default-ios-config, default-macos-config, default-react-native-config, default-react-native-expo-config, other-config.

  • envs object

    Environment variables for the application workflows, e.g. {"env1":"val1","env2":"val2"}

    Hide envs attribute Show envs attribute object
    • * string Additional properties
  • mode string

    config specification mode, has to be specified with manual value

  • 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

  • project_type string Required

    The type of your project (android, ios, cordova, other, xamarin, macos, ionic, react-native, fastlane, null)

  • stack_id string Required

    The id of the stack the application will be built (these can be found in the system report file names)

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • branch_name string
    • build_trigger_token string
    • is_webhook_auto_reg_supported boolean
    • status string
  • 400

    Bad Request

    Hide response attribute Show response attribute object
    • message string
  • 401

    Unauthorized

    Hide response attribute Show response attribute object
    • message string
  • 404

    Not Found

    Hide response attribute Show response attribute object
    • message string
  • 500

    Internal Server Error

    Hide response attribute Show response attribute object
    • message string
POST /apps/{app-slug}/finish
curl \
 --request POST 'https://api.bitrise.io/v0.1/apps/{app-slug}/finish' \
 --header "Authorization: $API_KEY" \
 --data '{"config":"string","envs":{"additionalProperty1":"string","additionalProperty2":"string"},"mode":"string","organization_slug":"string","project_type":"string","stack_id":"string"}'
Request examples
{
  "config": "string",
  "envs": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "mode": "string",
  "organization_slug": "string",
  "project_type": "string",
  "stack_id": "string"
}
Response examples (200)
{
  "branch_name": "string",
  "build_trigger_token": "string",
  "is_webhook_auto_reg_supported": true,
  "status": "string"
}
Response examples (400)
{
  "message": "string"
}
Response examples (401)
{
  "message": "string"
}
Response examples (404)
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}