Skip to main content
POST
Create Sidecar

Body

application/json

The request body resource

name
string
required

Unique name of the resource

Example:

"payments-sidecar"

Response

Created

connections
string[]

Names of the connections this sidecar fronts

Example:
created_at
string

Creation timestamp

created_by
string

Subject of the admin who created it

id
string<uuid>
read-only

Unique identifier

last_seen_at
string

Last time this gateway process saw the sidecar. Same lifetime as Version.

name
string

Human-readable name

Example:

"payments-sidecar"

org_id
string<uuid>
read-only

Organization ID

token
string

The generated token, sent in the hoop-sidecar-token header. This is the only time it is shown; it is stored hashed and cannot be recovered.

Example:

"hsc_Ab3fX9kL..."

version
string

Version reported at the last handshake. Held in gateway memory, not stored, so it is empty until the sidecar calls and again after a gateway restart.

Example:

"1.0.0"