Sign Android Application

Learn more about:

POST Parameters

List with common parameters for all Buddy actions

NameTypeDescription
name
Required		StringThe name of the action.
type
Required		StringThe type of the action. Should be set to ANDROID_SIGN.
local_path
Required		StringThe path to the generated .apk file.
application_name
Required		StringThe name of the signed APK file.
key_path
Required		StringThe path to the private key in JSON format with permissions to Google Play Developer Console.
build_tool_version
Required		StringThe version of the Android Build Tools.
keystore_password
Required		StringThe keystore password.
output_dirStringThe directory in which the signed APK will be stored.
key_passwordStringThe key password.
key_aliasStringThe key alias name.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
  "name": "Sign Android App",
  "type": "ANDROID_SIGN",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "local_path": "my-app-unsigned-aligned.apk",
  "output_dir": "out",
  "application_name": "my-app-release.apk",
  "key_path": "my-release-key.jks",
  "key_alias": "",
  "key_password": "${key_password}",
  "keystore_password": "${keystore_password}",
  "build_tool_version": "26.0.2"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
  "id": 2,
  "name": "Sign Android App",
  "type": "ANDROID_SIGN",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "last_execution_status": "INITIAL",
  "local_path": "my-app-unsigned-aligned.apk",
  "output_dir": "out",
  "application_name": "my-app-release.apk",
  "key_path": "my-release-key.jks",
  "key_alias": "",
  "key_password": "${key_password}",
  "keystore_password": "${keystore_password}",
  "build_tool_version": "26.0.2",
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "Live mirror",
    "trigger_mode": "MANUAL",
    "ref_name": "master",
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.