Distribution

R2 delivery metadata

Returns the R2 bucket, the prefixes a credential may name, the credential TTL limits in seconds, the catalog object and whether the caller's plan carries R2 delivery. AUTHENTICATED (signed-in session only): an anonymous call gets HTTP 401 from the session gate and an API key is not accepted. Credentials themselves are minted with POST on the same path from a signed-in session (see https://propraven.com/docs/r2); that operation is not part of the API-key contract.

get/api/v1/r2-credentials

Request

  • Base URL: https://propraven.com
  • URL: https://propraven.com/api/v1/r2-credentials
  • Auth: API key in cookie sb-<project-ref>-auth-token

Response

R2 delivery metadata.

bucketstring required
endpoint_templatestring required
regionstring required
available_prefixesstring[] required
max_ttl_secondsinteger required
default_ttl_secondsinteger required
docsstring required
entitledboolean nullable required

Whether the caller's plan carries R2 delivery; null when the plan lookup failed.

upgrade_urlstring required

Example response

{
  "bucket": "propraven-data",
  "endpoint_template": "https://<account_id>.r2.cloudflarestorage.com",
  "region": "auto",
  "available_prefixes": [
    "parcels-silver/",
    "parcels-wide/",
    "permits/",
    "_catalog.json"
  ],
  "max_ttl_seconds": 43200,
  "default_ttl_seconds": 43200,
  "docs": "https://propraven.com/docs/r2",
  "catalog": {
    "uri": "s3://propraven-data/_catalog.json",
    "prefix": "_catalog.json"
  },
  "upgrade_url": "https://propraven.com/subscribe"
}

Changes

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