BAbannerbear

Create an instant URL

Changed on
post/instant_urls

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Request body

namestring required
templatestring required

Image template UID this Instant URL is bound to

mode'encoded' | 'named_params'
security'signed' | 'open'
status'active' | 'disabled'
scale1 | 2 | 3 | 4
rate_limitboolean
template_versioninteger nullable
max_rendersinteger nullable
expires_atstring date-time nullable

Response

Instant URL created. The signing_key field is only returned here — store it now.

uidstring
namestring
templatestring

Source image template UID

template_versioninteger nullable

Pinned template version, or null for latest

mode'encoded' | 'named_params'
security'signed' | 'open'
status'active' | 'disabled'
scale1 | 2 | 3 | 4
rate_limitboolean

Whether per-IP rate limiting is enabled

max_rendersinteger nullable
render_countinteger
expires_atstring date-time nullable
base_urlstring uri
sample_urlstring uri
created_atstring date-time
signing_keystring

HMAC signing key. Only returned at creation time — store it now.

Changes

  • 6aa425420a10Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status