Databases

REST API (Upstash-compatible) of a Redis database: on or off, its address, live tokens (never their values)

get/databases/{databaseId}/rest

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/databases/{databaseId}/rest
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

databaseIdstring uuid required

Response

REST API

databaseIdstring uuid required
supportedboolean required

the REST API exists for Redis databases only

enabledboolean required
publicboolean required

also answers on the public https address (for browsers and builds outside the team network)

status'disabled' | 'provisioning' | 'running' | 'error' required

the team's REST gateway: provisioning while it starts (about a minute the first time)

statusDetailstring nullable required
restUrlstring nullable required

KV_REST_API_URL / UPSTASH_REDIS_REST_URL for apps on the team network (http://kvrest-<id>:8079)

publicUrlstring nullable required

the public https address, when public is on

notesstring[] required
updatedAtstring nullable required

ISO-8601 timestamp

Changes

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