Qodex.ai

export_to_s3

POST http://localhost:9925

This method is used to perform a search and export the results in the format specified to an S3 bucket. The searchoperation can be a searchbyvalue, searchby_hash, or sql operation.

  • operation (required) - must always be exporttos3

  • format (required) - the format you wish to export the data, options are json & csv

  • s3 (required) - details your access keys, bucket and key for saving the data to S3

  • searchoperation (required) - searchoperation of searchbyhash, searchbyvalue or sql

    • Request Body

    {"operation"=>"export_to_s3", "format"=>"json", "s3"=>{"aws_access_key_id"=>"YOUR_KEY", "aws_secret_access_key"=>"YOUR_SECRET_KEY", "bucket"=>"BUCKET", "key"=>"FILENAME"}, "search_operation"=>{"operation"=>"sql", "sql"=>"SELECT * FROM dev.dog"}}

    HEADERS

    KeyDatatypeRequiredDescription
    Content-Typestring
    Authorizationstring

    RESPONSES

    status: OK

    {"message":"Starting job with id 77ffcacd-33b9-49c2-a82b-eab6bcb080f1"}