Upload

Create signed URL

Retrieve a signed URL link to upload a file to the Escape Platform.

By running a query with this endpoint, you will receive a signed URL that you can use to upload a file to the Escape Platform.

{
  "url": "[SIGNED URL]",
  "id": "[SIGNED URL ID]"
}

With the url, you are able to upload one file:

curl -X PUT --data-binary '@./schema.json' "[SIGNED URL]"

Now, you are able to use the previously received id in another query. For example to update a schema of your application.

Optionally pass contentType and filename query parameters so the uploaded object keeps its MIME type and original name:

curl -X POST "/v3/upload/signed-url?contentType=application/json&filename=schema.har"

When contentType is provided it is part of the signed request, so the PUT must send the same Content-Type header:

curl -X PUT -H "Content-Type: application/json" --data-binary '@./schema.json' "[SIGNED URL]"
post/upload/signed-url

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Query parameters

contentTypestring

The MIME type of the file to upload, e.g. application/json. Stored on the uploaded object. When provided, the PUT must send the same Content-Type.

Example:application/json
filenamestring

The original file name, e.g. schema.har. Used to build the storage key so the uploaded object keeps its original name.

Example:schema.har

Response

OK

urlstring uri required

The signed URL to upload a file to the Escape Platform.

idstring uuid required

The signed URL ID to upload a file to the Escape Platform.

Changes

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