Skip to content
Dashboard
Theme
Theme

Signed upload for an ImportBundle

POST /v1/uploads: Signed upload for an ImportBundle.

View Markdown

POST /v1/uploads

Create a single-use, environment-scoped upload for an ImportBundle of at most 16 MiB. Send exactly size_bytes bytes to upload_url using upload_method and every value in upload_headers, then create the import with bundle_upload_id before expires_at. The signer supplies the required headers; Content-Type is not promised to be signed. The import validates and freezes the uploaded bytes before consuming the upload, so later object changes cannot change a queued import.

Scope
imports:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • purpose string Required

    one of import_bundle, csv_saml, auth0_users, auth0_mapping

  • size_bytes integer Required

    Exact uploaded byte length. ImportBundle and CSV ZIP uploads are limited to 16 MiB. Auth0 JSON lines exports are limited to 64 MiB and streamed; Auth0 organization CSV mappings are limited to 5 MiB.

    min 1

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/uploads" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"purpose": "import_bundle",
"size_bytes": 1
}'
Response 201
{
"id": "upl_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "upload",
"upload_url": "https://app.acme.com/callback",
"upload_method": "PUT",
"upload_headers": {},
"expires_at": "2026-01-15T09:30:00Z"
}