Code sign and export an iOS app

  • 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_SIGN.
archive_locationrequired string
The filesystem path of the signed archive file.
export_locationstring
Defines the filesystem path to which the signed file is exported.
property_list_sourcestring
Defines the source of the property_list used by the action. Available options: ACTION, GENERATED,PIPELINE_VOLUME.
property_liststring
Filesystem path of the properties file or the list of properties separated by the newline character \n.
distribution_methodstring
Defines the distribution method from one of the available: APP_STORE, ENTERPRISE, AD_HOC, DEVELOPMENT.
certificatesstring[]
The list of variables added to the iOS keychain.
provision_profilesstring[]
The list of variables added as iOS Provisioning Profiles.

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": "Sign and export",
  "type": "NATIVE_BUILD_MAC_SIGN",
  "trigger_time": "ON_EVERY_EXECUTION",
  "export_location": "/",
  "distribution_method": "APP_STORE",
  "property_list_source": "ACTION",
  "property_list": "list",
  "certificates": [
    "myCert"
  ],
  "provision_profiles": [
    "myProvisionProfile"
  ]
}'
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 and export", "type": "NATIVE_BUILD_MAC_SIGN", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "export_location": "/", "distribution_method": "APP_STORE", "property_list_source": "ACTION", "property_list": "list", "certificates": [ "myCert" ], "provision_profiles": [ "myProvisionProfile" ], "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