Sign Android Application

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to ANDROID_SIGN.
local_pathrequired string
The path to the generated .apk file.
application_namerequired string
The name of the signed APK file.
key_pathrequired string
The path to the private key in JSON format with permissions to Google Play Developer Console.
build_tool_versionrequired string
The version of the Android Build Tools.
keystore_passwordrequired string
The keystore password.
output_diroptional string
The directory in which the signed APK will be stored.
key_passwordoptional string
The key password.
key_aliasoptional string
The key alias name.

Last modified on Oct 7, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sign Android App",
  "type": "ANDROID_SIGN",
  "trigger_time": "ON_EVERY_EXECUTION",
  "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"
}'
EXAMPLE RESPONSE
{ "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", "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", "on": "CLICK", "refs": [ "refs/heads/master" ], "last_execution_status": "SUCCESSFUL", "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999