@@ -65367,6 +65367,149 @@ components:
6536765367 type: string
6536865368 x-enum-varnames:
6536965369 - SUITES
65370+ SyntheticsTestFileAbortMultipartUploadRequest:
65371+ description: Request body for aborting a multipart file upload.
65372+ properties:
65373+ key:
65374+ description: The full storage path of the file whose upload should be aborted.
65375+ example: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65376+ type: string
65377+ uploadId:
65378+ description: The upload ID of the multipart upload to abort.
65379+ example: "upload-id-abc123"
65380+ type: string
65381+ required:
65382+ - uploadId
65383+ - key
65384+ type: object
65385+ SyntheticsTestFileCompleteMultipartUploadPart:
65386+ description: A completed part of a multipart upload.
65387+ properties:
65388+ ETag:
65389+ description: The ETag returned by the storage provider after uploading the part.
65390+ example: '"d41d8cd98f00b204e9800998ecf8427e"'
65391+ type: string
65392+ PartNumber:
65393+ description: The 1-indexed part number for the multipart upload.
65394+ example: 1
65395+ format: int64
65396+ type: integer
65397+ required:
65398+ - ETag
65399+ - PartNumber
65400+ type: object
65401+ SyntheticsTestFileCompleteMultipartUploadRequest:
65402+ description: Request body for completing a multipart file upload.
65403+ properties:
65404+ key:
65405+ description: The full storage path for the uploaded file.
65406+ example: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65407+ type: string
65408+ parts:
65409+ description: Array of completed parts with their ETags.
65410+ items:
65411+ $ref: "#/components/schemas/SyntheticsTestFileCompleteMultipartUploadPart"
65412+ type: array
65413+ uploadId:
65414+ description: The upload ID returned when the multipart upload was initiated.
65415+ example: "upload-id-abc123"
65416+ type: string
65417+ required:
65418+ - uploadId
65419+ - key
65420+ - parts
65421+ type: object
65422+ SyntheticsTestFileDownloadRequest:
65423+ description: Request body for getting a presigned download URL for a test file.
65424+ properties:
65425+ bucketKey:
65426+ description: The bucket key referencing the file to download.
65427+ example: "api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65428+ minLength: 1
65429+ type: string
65430+ required:
65431+ - bucketKey
65432+ type: object
65433+ SyntheticsTestFileDownloadResponse:
65434+ description: Response containing a presigned URL for downloading a test file.
65435+ properties:
65436+ url:
65437+ description: A presigned URL to download the file. The URL expires after a short period.
65438+ example: "https://storage.example.com/presigned-download-url"
65439+ type: string
65440+ type: object
65441+ SyntheticsTestFileMultipartPresignedUrlsParams:
65442+ description: Presigned URL parameters returned for a multipart upload.
65443+ properties:
65444+ key:
65445+ description: The full storage path for the file being uploaded.
65446+ example: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65447+ type: string
65448+ upload_id:
65449+ description: The upload ID assigned by the storage provider for this multipart upload.
65450+ example: "upload-id-abc123"
65451+ type: string
65452+ urls:
65453+ additionalProperties:
65454+ type: string
65455+ description: A map of part numbers to presigned upload URLs.
65456+ example:
65457+ "1": "https://storage.example.com/presigned-upload-url-part-1"
65458+ "2": "https://storage.example.com/presigned-upload-url-part-2"
65459+ type: object
65460+ type: object
65461+ SyntheticsTestFileMultipartPresignedUrlsPart:
65462+ description: A part descriptor for initiating a multipart upload.
65463+ properties:
65464+ md5:
65465+ description: Base64-encoded MD5 digest of the part content.
65466+ example: "1B2M2Y8AsgTpgAmY7PhCfg=="
65467+ maxLength: 24
65468+ minLength: 22
65469+ type: string
65470+ partNumber:
65471+ description: The 1-indexed part number for the multipart upload.
65472+ example: 1
65473+ format: int64
65474+ type: integer
65475+ required:
65476+ - md5
65477+ - partNumber
65478+ type: object
65479+ SyntheticsTestFileMultipartPresignedUrlsRequest:
65480+ description: Request body for getting presigned URLs for a multipart file upload.
65481+ properties:
65482+ bucketKeyPrefix:
65483+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequestBucketKeyPrefix"
65484+ parts:
65485+ description: Array of part descriptors for the multipart upload.
65486+ items:
65487+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsPart"
65488+ type: array
65489+ required:
65490+ - bucketKeyPrefix
65491+ - parts
65492+ type: object
65493+ SyntheticsTestFileMultipartPresignedUrlsRequestBucketKeyPrefix:
65494+ description: The bucket key prefix indicating the type of file upload.
65495+ enum:
65496+ - api-upload-file
65497+ - browser-upload-file-step
65498+ example: "api-upload-file"
65499+ type: string
65500+ x-enum-varnames:
65501+ - API_UPLOAD_FILE
65502+ - BROWSER_UPLOAD_FILE_STEP
65503+ SyntheticsTestFileMultipartPresignedUrlsResponse:
65504+ description: Response containing presigned URLs for multipart file upload and the bucket key.
65505+ properties:
65506+ bucketKey:
65507+ description: The bucket key that references the uploaded file after completion.
65508+ example: "api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
65509+ type: string
65510+ multipart_presigned_urls_params:
65511+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsParams"
65512+ type: object
6537065513 SyntheticsTestOptions:
6537165514 description: Object describing the extra options for a Synthetic test.
6537265515 properties:
@@ -106856,6 +106999,237 @@ paths:
106856106999 permissions:
106857107000 - synthetics_write
106858107001 - synthetics_create_edit_trigger
107002+ /api/v2/synthetics/tests/{public_id}/files/download:
107003+ post:
107004+ description: |-
107005+ Get a presigned URL to download a file attached to a Synthetic test.
107006+ The returned URL is temporary and expires after a short period.
107007+ operationId: GetTestFileDownloadUrl
107008+ parameters:
107009+ - description: The public ID of the Synthetic test.
107010+ in: path
107011+ name: public_id
107012+ required: true
107013+ schema:
107014+ example: abc-def-123
107015+ type: string
107016+ requestBody:
107017+ content:
107018+ application/json:
107019+ schema:
107020+ $ref: "#/components/schemas/SyntheticsTestFileDownloadRequest"
107021+ required: true
107022+ responses:
107023+ "200":
107024+ content:
107025+ application/json:
107026+ schema:
107027+ $ref: "#/components/schemas/SyntheticsTestFileDownloadResponse"
107028+ description: OK
107029+ "400":
107030+ content:
107031+ application/json:
107032+ schema:
107033+ $ref: "#/components/schemas/APIErrorResponse"
107034+ description: API error response.
107035+ "403":
107036+ content:
107037+ application/json:
107038+ schema:
107039+ $ref: "#/components/schemas/APIErrorResponse"
107040+ description: Forbidden.
107041+ "404":
107042+ content:
107043+ application/json:
107044+ schema:
107045+ $ref: "#/components/schemas/APIErrorResponse"
107046+ description: API error response.
107047+ "429":
107048+ $ref: "#/components/responses/TooManyRequestsResponse"
107049+ security:
107050+ - apiKeyAuth: []
107051+ appKeyAuth: []
107052+ - AuthZ:
107053+ - synthetics_read
107054+ summary: Get a presigned URL for downloading a test file
107055+ tags:
107056+ - Synthetics
107057+ x-permission:
107058+ operator: OR
107059+ permissions:
107060+ - synthetics_read
107061+ /api/v2/synthetics/tests/{public_id}/files/multipart-presigned-urls:
107062+ post:
107063+ description: |-
107064+ Get presigned URLs for uploading a file to a Synthetic test using multipart upload.
107065+ Returns the presigned URLs for each part along with the bucket key that will reference the file.
107066+ operationId: GetTestFileMultipartPresignedUrls
107067+ parameters:
107068+ - description: The public ID of the Synthetic test.
107069+ in: path
107070+ name: public_id
107071+ required: true
107072+ schema:
107073+ example: abc-def-123
107074+ type: string
107075+ requestBody:
107076+ content:
107077+ application/json:
107078+ schema:
107079+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequest"
107080+ required: true
107081+ responses:
107082+ "200":
107083+ content:
107084+ application/json:
107085+ schema:
107086+ $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsResponse"
107087+ description: OK
107088+ "400":
107089+ content:
107090+ application/json:
107091+ schema:
107092+ $ref: "#/components/schemas/APIErrorResponse"
107093+ description: API error response.
107094+ "403":
107095+ content:
107096+ application/json:
107097+ schema:
107098+ $ref: "#/components/schemas/APIErrorResponse"
107099+ description: Forbidden.
107100+ "404":
107101+ content:
107102+ application/json:
107103+ schema:
107104+ $ref: "#/components/schemas/APIErrorResponse"
107105+ description: API error response.
107106+ "429":
107107+ $ref: "#/components/responses/TooManyRequestsResponse"
107108+ security:
107109+ - apiKeyAuth: []
107110+ appKeyAuth: []
107111+ - AuthZ:
107112+ - synthetics_write
107113+ summary: Get presigned URLs for uploading a test file
107114+ tags:
107115+ - Synthetics
107116+ x-permission:
107117+ operator: OR
107118+ permissions:
107119+ - synthetics_write
107120+ - synthetics_create_edit_trigger
107121+ /api/v2/synthetics/tests/{public_id}/files/multipart-upload-abort:
107122+ post:
107123+ description: |-
107124+ Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload
107125+ and releases any storage used by already-uploaded parts.
107126+ operationId: AbortTestFileMultipartUpload
107127+ parameters:
107128+ - description: The public ID of the Synthetic test.
107129+ in: path
107130+ name: public_id
107131+ required: true
107132+ schema:
107133+ example: abc-def-123
107134+ type: string
107135+ requestBody:
107136+ content:
107137+ application/json:
107138+ schema:
107139+ $ref: "#/components/schemas/SyntheticsTestFileAbortMultipartUploadRequest"
107140+ required: true
107141+ responses:
107142+ "204":
107143+ description: No Content
107144+ "400":
107145+ content:
107146+ application/json:
107147+ schema:
107148+ $ref: "#/components/schemas/APIErrorResponse"
107149+ description: API error response.
107150+ "403":
107151+ content:
107152+ application/json:
107153+ schema:
107154+ $ref: "#/components/schemas/APIErrorResponse"
107155+ description: Forbidden.
107156+ "404":
107157+ content:
107158+ application/json:
107159+ schema:
107160+ $ref: "#/components/schemas/APIErrorResponse"
107161+ description: API error response.
107162+ "429":
107163+ $ref: "#/components/responses/TooManyRequestsResponse"
107164+ security:
107165+ - apiKeyAuth: []
107166+ appKeyAuth: []
107167+ - AuthZ:
107168+ - synthetics_write
107169+ summary: Abort a multipart upload of a test file
107170+ tags:
107171+ - Synthetics
107172+ x-permission:
107173+ operator: OR
107174+ permissions:
107175+ - synthetics_write
107176+ - synthetics_create_edit_trigger
107177+ /api/v2/synthetics/tests/{public_id}/files/multipart-upload-complete:
107178+ post:
107179+ description: |-
107180+ Complete a multipart file upload for a Synthetic test. Call this endpoint after all parts
107181+ have been uploaded using the presigned URLs obtained from the multipart presigned URLs endpoint.
107182+ operationId: CompleteTestFileMultipartUpload
107183+ parameters:
107184+ - description: The public ID of the Synthetic test.
107185+ in: path
107186+ name: public_id
107187+ required: true
107188+ schema:
107189+ example: abc-def-123
107190+ type: string
107191+ requestBody:
107192+ content:
107193+ application/json:
107194+ schema:
107195+ $ref: "#/components/schemas/SyntheticsTestFileCompleteMultipartUploadRequest"
107196+ required: true
107197+ responses:
107198+ "204":
107199+ description: No Content
107200+ "400":
107201+ content:
107202+ application/json:
107203+ schema:
107204+ $ref: "#/components/schemas/APIErrorResponse"
107205+ description: API error response.
107206+ "403":
107207+ content:
107208+ application/json:
107209+ schema:
107210+ $ref: "#/components/schemas/APIErrorResponse"
107211+ description: Forbidden.
107212+ "404":
107213+ content:
107214+ application/json:
107215+ schema:
107216+ $ref: "#/components/schemas/APIErrorResponse"
107217+ description: API error response.
107218+ "429":
107219+ $ref: "#/components/responses/TooManyRequestsResponse"
107220+ security:
107221+ - apiKeyAuth: []
107222+ appKeyAuth: []
107223+ - AuthZ:
107224+ - synthetics_write
107225+ summary: Complete a multipart upload of a test file
107226+ tags:
107227+ - Synthetics
107228+ x-permission:
107229+ operator: OR
107230+ permissions:
107231+ - synthetics_write
107232+ - synthetics_create_edit_trigger
106859107233 /api/v2/synthetics/variables/{variable_id}/jsonpatch:
106860107234 patch:
106861107235 description: |-
0 commit comments