Skip to main content
Describe the channel this key belongs to (any key, about itself)
Preview. This operation is not served yet: it is part of the released contract (version 1.0.0). Build against a mock of the contract until the sandbox serves it; see Testing: mock and sandbox.

Authorizations

Authorization
string
header
required

A key starts with gbd_live_ (production) or gbd_test_ (sandbox) and ends in a CRC32 checksum of its secret part, so a mistyped or truncated key is refused before any lookup, as is a key of the other environment. The prefix is registered with public secret scanners (GitHub secret scanning, TruffleHog, GitGuardian): a key found in a public repository is revoked at once and your technical contact is told. Gridbeds stores only a hash of each key. One partner may hold two keys per environment during a rotation. Operations list the scopes they need; the scopes are OAuth 2.0 scope tokens, so short-lived access tokens from a client-credentials grant can be offered later beside keys, with the same scopes and no change to any operation.

Response

The channel.

channel
string
required

Your channel's name; the aud of an owner-connect token.

Example:

"housera"

environment
enum<string>
required
Available options:
live,
test
scopes
enum<string>[]
required

Open enum. write:listings covers what you report back to Gridbeds, listing reports and owner connections. write:bookings is reserved.

Available options:
read:catalog,
read:ari,
manage:webhooks,
write:listings
rate_limit
object
required
properties_distributed
integer
required

Properties currently active or inactive for you.

Required range: x >= 0
name
string
key
object
events
object
owner_connect
object

Additive. Your owner-connect setting in the environment of the key that asks, registered with Gridbeds.