Add an SSH-key to a specific app

POST /apps/{app-slug}/register-ssh-key

Add an SSH-key to a specific app. After creating an app, you need to register the SSH key so that Bitrise will be able to access and clone your repository during the build process. This requires the app slug of your newly created app.

Path parameters

  • app-slug string Required

    App slug

Body Required

SSH key parameters

  • auth_ssh_private_key string Required

    The private part of the SSH key you would like to use

  • auth_ssh_public_key string Required

    The public part of the SSH key you would like to use

  • is_register_key_into_provider_service boolean

    If it's set to true, the provided SSH key will be registered at the provider of the application

Responses

  • 200

    OK

    Hide response attribute Show response attribute object
    • 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}/register-ssh-key
curl \
 --request POST 'https://api.bitrise.io/v0.1/apps/{app-slug}/register-ssh-key' \
 --header "Authorization: $API_KEY" \
 --data '{"auth_ssh_private_key":"string","auth_ssh_public_key":"string","is_register_key_into_provider_service":true}'
Request examples
{
  "auth_ssh_private_key": "string",
  "auth_ssh_public_key": "string",
  "is_register_key_into_provider_service": true
}
Response examples (200)
{
  "status": "string"
}
Response examples (400)
{
  "message": "string"
}
Response examples (401)
{
  "message": "string"
}
Response examples (404)
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}