RUrunway
app

Upload a build for a 'Custom CI' integration

Please note the unique upload server URL for this endpoint.

The binary file must be included in a 'file' field as form data. Please see below for an example curl request:

curl -X POST \
    -F "file=@example.ipa" \
    -F 'data={\"version\":\"1.2.3\",\"ciBuildInfo\":{\"buildIdentifier\":\"123\",\"status\":\"inProgress\",\"startedAt\":\"2022-03-02T01:15:00Z\",\"branch\":\"release-1.2.3\",\"commitHash\":\"abcdef\",\"integrationId\":\"custom-ci\",\"workflowData\":{\"workflowId\":\"123\"}}}}'  \
    -H "X-API-KEY:API-KEY" \
    https://upload-api.runway.team/v1/app/{appId}/integration/{integrationInstallationId}/build
post/app/{appId}/integration/{integrationInstallationId}/build

Request

  • Base URL
    https://upload-api.runway.team/v1
  • URL
    https://upload-api.runway.team/v1/app/{appId}/integration/{integrationInstallationId}/build
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

integrationInstallationIdstring required

The unique installation ID for the integration. Found in the corresponding integration settings in Runway. Has the format <integration type>:<random string>, for example custom-ci:d5onv9mfdkkqlsl3cie0.

Request body multipart/form-data

filestring binary required

Example request

{
  "data": {
    "ciBuildInfo": {
      "buildIdentifier": "123",
      "startedAt": "2022-03-02T01:15:00Z",
      "finishedAt": "2022-03-02T01:15:00Z",
      "commitHash": "e7a5fcf0f92ff69d59333ed0e40194f3c96791f6",
      "branch": "main",
      "workflowData": {
        "workflowId": "12345",
        "workflowName": "Build and Test"
      }
    }
  }
}

Response

Successfully uploaded build

Example response

{
  "ciBuild": {
    "buildHash": "abc123def456",
    "buildIdentifier": "123",
    "buildUrl": "https://ci.example.com/build/123",
    "buildStartedAt": "2022-03-02T01:15:00Z",
    "buildFinishedAt": "2022-03-02T01:20:00Z",
    "providerBuildStatusString": "In progress",
    "commit": "abcdef123456",
    "commitMessage": "Fix bug in authentication",
    "commitAuthor": "John Doe",
    "commitUrl": "https://github.com/org/repo/commit/abcdef123456",
    "workflowName": "CI Build",
    "branchName": "main",
    "workflowRunIdOrCommaDelimitedIds": "workflow-run-123",
    "artifacts": [
      {
        "artifactId": "a1b2c3",
        "fileName": "example.ipa",
        "size": 52428800,
        "downloadUrl": "https://app.runway.team/...",
        "version": "1.2.3",
        "binaryBuildDetails": {
          "artifactType": "ipa",
          "bundleName": "com.example.app",
          "versionString": "1.2.3",
          "appName": "Example",
          "buildIdentifier": "123"
        }
      }
    ]
  },
  "associatedAppStoreBuild": {
    "buildNumber": "123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.