Secure Upload

API to be used by the clients to generate the presigned upload URL. Thus generated upload URL can then be used to send performance data to our platform.

Generate presigned upload URL for sending performance data

API to be used by the clients to generate the presigned upload URL. Thus generated upload URL can then be used to send performance data to our platform.

POSThttps://api.cloudfactory.app/v1/workstreams/{workstream_id}/performance/generate-presigned-url

Path parameters

workstream_id*string

CloudFactory platform WorkStream ID

Header parameters

Body

application/json

Generate Presigned URL Object

type*enum

Type of the performance data that will be uploaded later

Example: "throughput"

throughputqualitythroughput_quality

use_case_idstring

ID of the use case with which the performance data is associated with. [Will be provided by CloudFactory]

Example: "rr3d6802-0efa-46de-a73c-6c24f094dfcf"

task_definition_idstring

ID of the task definition with which the performance data is associated with. [Will be provided by CloudFactory]

Example: "032d6802-0efa-46de-a73c-6c24f094dfcf"

Response

200400401403404422500

Successful

Body

application/json

expires_atstring

Example: "2023-08-10T14:39:41Z"

file_namestring

Example: "06b6780f-ab7a-40cd-9741-e2823c3e5d19-1691642381.csv"

urlstring

Example: "https://example.com"

Request

JavaScriptCurlPython

const response = await fetch('https://api.cloudfactory.app/v1/workstreams/{workstream_id}/performance/generate-presigned-url', {
    method: 'POST',
    headers: {
      "x-api-key": "loAwlMCCxv4TlpLWR8a2e6",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "throughput"
    }),
});
const data = await response.json();

Response

200400401403404422500

{
  "expires_at": "2023-08-10T14:39:41Z",
  "file_name": "06b6780f-ab7a-40cd-9741-e2823c3e5d19-1691642381.csv",
  "url": "https://example.com"
}