Storage

Request a presigned URL for file upload

Changed on

Returns a presigned GCS URL for direct upload. The client sends JSON metadata here, then uploads the file directly to the returned URL.

post/storage/uploads/request-url

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/storage/uploads/request-url
  • Auth: none required

Request body

namestring required

Original file name.

sizeinteger required

File size in bytes.

contentTypestring required

MIME type of the file.

domainstring

Product domain for file type allowlist enforcement (e.g. "prism", "terra", "vessels", "aegis", "lyte", "szl", "carlota-jo"). Omit or use "default" for the global allowlist.

orgIdinteger

Org ID for quota enforcement. Required when uploading on behalf of an org.

Response

Presigned upload URL generated.

uploadURLstring uri required

Presigned GCS URL for PUT upload.

objectPathstring required

Normalized object path (e.g. /objects/uploads/uuid). Store this in your database.

Changes

  • b25c77d7653bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • ee05a5224ed5Revision changes
    • info

      endpoint added