Deploy to App Store Connect

  • 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
actionrequired string
The ID of the action.
typerequired string
The type of the action. Must be set to NATIVE_BUILD_MAC_DEPLOY.
archive_locationrequired string
The filesystem path of the signed archive file.
validate_before_uploadoptional boolean
Defines if the app is submitted to Fastlane pre-check before sending for review.
submit_for_reviewoptional boolean
Defines if the app is sent to review.
skip_metadataoptional boolean
Defines if the app metadata is updated.
skip_app_version_updateoptional boolean
Defines if the app version is increased.
skip_screenshotsoptional boolean
Defines is the app screenshots are updated.

Last modified on Sep 27, 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": "Deploy to App Store Connect",
  "type": "NATIVE_BUILD_MAC_DEPLOY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "archive_location": "$BUDDY_SIGNED_IPA_PATH",
  "validate_before_upload": true,
  "submit_for_review": true,
  "skip_metadata": true,
  "skip_app_version_update": true,
  "skip_screenshots": true,
  "integration": {
    "hash_id": "X2lwGqLkzPdyJqMVeQrov3KBgA"
  }
}'
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/pipeline/2/action/2/edit", "id": 2, "name": "Deploy to App Store Connect", "type": "NATIVE_BUILD_MAC_DEPLOY", "trigger_time": "ON_EVERY_EXECUTION", "archive_location": "$BUDDY_SIGNED_IPA_PATH", "validate_before_upload": true, "submit_for_review": true, "skip_metadata": true, "skip_app_version_update": true, "skip_screenshots": true, "integration": { "hash_id": "X2lwGqLkzPdyJqMVeQrov3KBgA" }, "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": "INITIAL", "last_execution_revision": null, "always_from_scratch": false, "ignore_fail_on_project_status": false, "no_skip_to_most_recent": false, "auto_clear_cache": false, "do_not_create_commit_status": false } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999