Deploy to App Store Connect

POST Parameters

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Must be set to NATIVE_BUILD_MAC_DEPLOY.
archive_location
Required
StringThe filesystem path of the signed archive file.
validate_before_uploadStringDefines if the app is submitted to Fastlane pre-check before sending for review.
submit_for_reviewBooleanDefines if the app is sent to review.
skip_metadataBooleanDefines if the app metadata is updated.
skip_app_version_updateBooleanDefines if the app version is increased.
skip_screenshotsBooleanDefines is the app screenshots are updated.

Sample Request

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

JSON

{
  "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,
  "skip_metadata": true,
  "skip_app_version_update": true,
  "skip_screenshots": true,
  "submit_for_review": true,
  "integration": {
    "hash_id": "X2lwGqLkzPdyJqMVeQrov3KBgA"
  }
}

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/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,
  "skip_metadata": true,
  "skip_app_version_update": true,
  "skip_screenshots": true,
  "submit_for_review": 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
  }
}

Last modified on November 16, 2022

Get Started

Sign up for free and deploy your project in less than 10 minutes.