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

post

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.

Path parameters

workstream_idstringrequired

CloudFactory platform WorkStream ID

Header parameters

x-api-keystringrequired

API key of the associated workstream, provided by CloudFactory

Example: loAwlMCCxv4TlpLWR8a2e6

Body

typestring · enumrequired

Type of the performance data that will be uploaded later

Example: throughput

Available options:

use_case_idstringoptional

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_idstringoptional

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

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

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.cloudfactory.app/v1/workstreams/{workstream_id}/performance/generate-presigned-url' \
  --header 'x-api-key: loAwlMCCxv4TlpLWR8a2e6' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "throughput",
    "use_case_id": "rr3d6802-0efa-46de-a73c-6c24f094dfcf",
    "task_definition_id": "032d6802-0efa-46de-a73c-6c24f094dfcf"
  }'

200

400

401

403

404

422

500

200

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

Successful