Bulk Geo Addressing

This V2 version generates url for uploading the file

This V2 version of API generates url for uploading the file to the S3 bucket. It takes the file name and returns the file id and pre-signed uploading URL which can be used to upload the file to the S3 bucket.

post/v2/files/upload-url

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v2/files/upload-url
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Request body

fileNamestring required

Name of the file to upload

Example request

{
  "fileName": "test.csv"
}

Response

File upload url generated Successfully

fileIdstring required

file Id for uploading file

urlstring url required

pre signed url for uploading the file on S3

messagestring required

message for the response

Example response

{
  "fileId": "8d907c8c-5b63-417f-b69f-2d33dbdd2fcd",
  "url": "https://us-east-1-test.s3.us-east-1.amazonaws.com/test/test_user_1%40precisely.com/input/test_new%3A%3A8d907c8c-5b63-417f-b69f-2d33dbdd2fcd%0A",
  "message": "This download URL will be valid for the next 10 mins."
}

Changes

No recorded changes to this operation across all 1 revision of this API.