RUrunway
buildDistro

Upload a build to a bucket

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={"testerNotes":"optional tester notes"}'  \
    -H "X-API-KEY:API-KEY" \
    https://upload-api.runway.team/v1/app/{appId}/bucket/{bucketId}/build
post/app/{appId}/bucket/{bucketId}/build

Request

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

Path parameters

appIdstring required

The id of the app

bucketIdstring required

The id of the bucket

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"
      }
    },
    "uploadedAt": "2022-03-02T01:15:00Z",
    "prNumber": 42
  }
}

Response

A Build Distro build response

buildIdstring required

The id of the Build Distro build

status'active' | 'expired' | 'deleted' required
bucketNamestring required

The name of the build's bucket

bucketIdstring required

The ID of the build's bucket

artifactFileNamestring

The name of the artifact file associated with the build

createdAtstring date-time required
updatedAtstring date-time required
testerNotesstring

Optional tester notes for the build

downloadURLstring

The url to download the build. The request to this URL must be authenticated with a Runway API key.

binaryBuildNumberstring

The build number found associated to the binary artifact

binaryBuildVersionstring

The build version found associated to the binary artifact

binaryBuildTypestring

The type of binary artifact

Example response

{
  "buildId": "12345",
  "bucketName": "CIs",
  "bucketId": "abc123",
  "artifactFileName": "my-app.ipa",
  "createdAt": "2022-03-02T01:15:00Z",
  "updatedAt": "2022-03-02T01:15:00Z",
  "downloadURL": "https://api.runway.team/v1/app/my-app/bucket/my-bucket/build/my-build/download",
  "ciBuildInfo": {
    "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"
  },
  "binaryBuildNumber": "12345",
  "binaryBuildVersion": "1.2.3",
  "binaryBuildType": "ipa",
  "additionalArtifacts": [
    {
      "fileName": "test_results.html",
      "size": 1048576,
      "downloadUrl": "https://api.runway.team/v1/app/my-app/bucket/my-bucket/build/my-build/additionalFiles/test_results.html"
    }
  ]
}

Changes

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