Abort a multipart upload of a test file

POST https://api.ap1.datadoghq.com/api/v2/synthetics/tests/{public_id}/files/multipart-upload-aborthttps://api.ap2.datadoghq.com/api/v2/synthetics/tests/{public_id}/files/multipart-upload-aborthttps://api.datadoghq.eu/api/v2/synthetics/tests/{public_id}/files/multipart-upload-aborthttps://api.ddog-gov.com/api/v2/synthetics/tests/{public_id}/files/multipart-upload-aborthttps://api.us2.ddog-gov.com/api/v2/synthetics/tests/{public_id}/files/multipart-upload-aborthttps://api.datadoghq.com/api/v2/synthetics/tests/{public_id}/files/multipart-upload-aborthttps://api.us3.datadoghq.com/api/v2/synthetics/tests/{public_id}/files/multipart-upload-aborthttps://api.us5.datadoghq.com/api/v2/synthetics/tests/{public_id}/files/multipart-upload-abort

Overview

Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload and releases any storage used by already-uploaded parts. This endpoint requires any of the following permissions:

  • synthetics_write
  • synthetics_create_edit_trigger

  • OAuth apps require the synthetics_write authorization scope to access this endpoint.

    Arguments

    Path Parameters

    Name

    Type

    Description

    public_id [required]

    string

    The public ID of the Synthetic test.

    Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    key [required]

    string

    The full storage path of the file whose upload should be aborted.

    uploadId [required]

    string

    The upload ID of the multipart upload to abort.

    {
      "key": "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json",
      "uploadId": "upload-id-abc123"
    }

    Response

    No Content

    API error response.

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Forbidden.

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    API error response.

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Code Example

                      ## default
    # 
    
    # Path parameters
    export public_id="abc-def-123"
    # Curl command
    curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/synthetics/tests/${public_id}/files/multipart-upload-abort" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "key": "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json", "uploadId": "upload-id-abc123" } EOF
    """
    Abort a multipart upload of a test file returns "No Content" response
    """
    
    from datadog_api_client import ApiClient, Configuration
    from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
    from datadog_api_client.v2.model.synthetics_test_file_abort_multipart_upload_request import (
        SyntheticsTestFileAbortMultipartUploadRequest,
    )
    
    body = SyntheticsTestFileAbortMultipartUploadRequest(
        key="org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json",
        upload_id="upload-id-abc123",
    )
    
    configuration = Configuration()
    with ApiClient(configuration) as api_client:
        api_instance = SyntheticsApi(api_client)
        api_instance.abort_test_file_multipart_upload(public_id="abc-def-123", body=body)
    

    Instructions

    First install the library and its dependencies and then save the example to example.py and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
    # Abort a multipart upload of a test file returns "No Content" response
    
    require "datadog_api_client"
    api_instance = DatadogAPIClient::V2::SyntheticsAPI.new
    
    body = DatadogAPIClient::V2::SyntheticsTestFileAbortMultipartUploadRequest.new({
      key: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json",
      upload_id: "upload-id-abc123",
    })
    api_instance.abort_test_file_multipart_upload("abc-def-123", body)
    

    Instructions

    First install the library and its dependencies and then save the example to example.rb and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
    // Abort a multipart upload of a test file returns "No Content" response
    
    package main
    
    import (
    	"context"
    	"fmt"
    	"os"
    
    	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
    	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
    )
    
    func main() {
    	body := datadogV2.SyntheticsTestFileAbortMultipartUploadRequest{
    		Key:      "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json",
    		UploadId: "upload-id-abc123",
    	}
    	ctx := datadog.NewDefaultContext(context.Background())
    	configuration := datadog.NewConfiguration()
    	apiClient := datadog.NewAPIClient(configuration)
    	api := datadogV2.NewSyntheticsApi(apiClient)
    	r, err := api.AbortTestFileMultipartUpload(ctx, "abc-def-123", body)
    
    	if err != nil {
    		fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.AbortTestFileMultipartUpload`: %v\n", err)
    		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    	}
    }
    

    Instructions

    First install the library and its dependencies and then save the example to main.go and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
    // Abort a multipart upload of a test file returns "No Content" response
    
    import com.datadog.api.client.ApiClient;
    import com.datadog.api.client.ApiException;
    import com.datadog.api.client.v2.api.SyntheticsApi;
    import com.datadog.api.client.v2.model.SyntheticsTestFileAbortMultipartUploadRequest;
    
    public class Example {
      public static void main(String[] args) {
        ApiClient defaultClient = ApiClient.getDefaultApiClient();
        SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
    
        SyntheticsTestFileAbortMultipartUploadRequest body =
            new SyntheticsTestFileAbortMultipartUploadRequest()
                .key("org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json")
                .uploadId("upload-id-abc123");
    
        try {
          apiInstance.abortTestFileMultipartUpload("abc-def-123", body);
        } catch (ApiException e) {
          System.err.println("Exception when calling SyntheticsApi#abortTestFileMultipartUpload");
          System.err.println("Status code: " + e.getCode());
          System.err.println("Reason: " + e.getResponseBody());
          System.err.println("Response headers: " + e.getResponseHeaders());
          e.printStackTrace();
        }
      }
    }
    

    Instructions

    First install the library and its dependencies and then save the example to Example.java and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
    // Abort a multipart upload of a test file returns "No Content" response
    use datadog_api_client::datadog;
    use datadog_api_client::datadogV2::api_synthetics::SyntheticsAPI;
    use datadog_api_client::datadogV2::model::SyntheticsTestFileAbortMultipartUploadRequest;
    
    #[tokio::main]
    async fn main() {
        let body = SyntheticsTestFileAbortMultipartUploadRequest::new(
            "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json".to_string(),
            "upload-id-abc123".to_string(),
        );
        let configuration = datadog::Configuration::new();
        let api = SyntheticsAPI::with_config(configuration);
        let resp = api
            .abort_test_file_multipart_upload("abc-def-123".to_string(), body)
            .await;
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
    

    Instructions

    First install the library and its dependencies and then save the example to src/main.rs and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
    /**
     * Abort a multipart upload of a test file returns "No Content" response
     */
    
    import { client, v2 } from "@datadog/datadog-api-client";
    
    const configuration = client.createConfiguration();
    const apiInstance = new v2.SyntheticsApi(configuration);
    
    const params: v2.SyntheticsApiAbortTestFileMultipartUploadRequest = {
      body: {
        key: "org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json",
        uploadId: "upload-id-abc123",
      },
      publicId: "abc-def-123",
    };
    
    apiInstance
      .abortTestFileMultipartUpload(params)
      .then((data: any) => {
        console.log(
          "API called successfully. Returned data: " + JSON.stringify(data)
        );
      })
      .catch((error: any) => console.error(error));
    

    Instructions

    First install the library and its dependencies and then save the example to example.ts and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"