Gateway
13 methods on the Gateway resource.
13 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";13 of 13
bindGatewayIngressdisableGatewayProviderenableGatewayProvidergetGatewayAuditgetGatewayStatuslistGatewayDevicesmintGatewayPairingmintGatewayStreamTicketredeemGatewayPairingrenameGatewayDevicerevokeGatewayDevicesetGatewaySurfaceunbindGatewayIngress
bindGatewayIngress
Confirm one subject against the verified public endpoint
compozy.gateway.bindGatewayIngress({ body }) → Promise<BindGatewayIngressResponse>
Request bodyGatewayIngressBindRequest
POST /api/gateway/ingress-bindingsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.bindGatewayIngress({ body: { /* request fields */ } });disableGatewayProvider
Disable one named connectivity provider for a gateway tier
compozy.gateway.disableGatewayProvider({ path, query }) → Promise<GatewayStatusPayload>
Options
- namestringpathrequired
- Connectivity provider name
- tierstringqueryrequired
- Gateway tier
POST /api/gateway/providers/{name}/disableapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.disableGatewayProvider({ path: { "name": "name" }, query: { "tier": "tier" } });enableGatewayProvider
Enable one connectivity provider for a gateway tier
compozy.gateway.enableGatewayProvider({ path, body }) → Promise<GatewayStatusPayload>
Options
- namestringpathrequired
- Connectivity provider name
Request bodyGatewayProviderEnableRequest
POST /api/gateway/providers/{name}/enableapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.enableGatewayProvider({ path: { "name": "name" }, body: { /* request fields */ } });getGatewayAudit
Audit the current gateway security posture
compozy.gateway.getGatewayAudit() → Promise<GatewayAuditPayload>
GET /api/gateway/auditapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.getGatewayAudit();getGatewayStatus
Get the operator-global gateway posture
compozy.gateway.getGatewayStatus() → Promise<GatewayStatusPayload>
GET /api/gateway/statusapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.getGatewayStatus();listGatewayDevices
List the operator-global paired device inventory
compozy.gateway.listGatewayDevices() → Promise<GatewayDevicesResponse>
GET /api/gateway/devicesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.listGatewayDevices();mintGatewayPairing
Mint a bounded one-time gateway pairing artifact
compozy.gateway.mintGatewayPairing() → Promise<GatewayPairingArtifactPayload>
POST /api/gateway/pairingsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.mintGatewayPairing();mintGatewayStreamTicket
Mint a short-lived single-use stream ticket
compozy.gateway.mintGatewayStreamTicket() → Promise<GatewayStreamTicketPayload>
POST /api/gateway/stream-ticketsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.mintGatewayStreamTicket();redeemGatewayPairing
Redeem a one-time gateway pairing artifact
compozy.gateway.redeemGatewayPairing({ body }) → Promise<GatewayIssuedCredentialPayload>
Request bodyGatewayPairingRedeemRequest
POST /api/gateway/pairings/redeemapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.redeemGatewayPairing({ body: { /* request fields */ } });renameGatewayDevice
Rename one paired gateway device
compozy.gateway.renameGatewayDevice({ path, body }) → Promise<GatewayDevicePayload>
Options
- idstringpathrequired
- Gateway device id
Request bodyGatewayDeviceRenameRequest
PATCH /api/gateway/devices/{id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.renameGatewayDevice({ path: { "id": "id" }, body: { /* request fields */ } });Show all 13 methods
revokeGatewayDevice
Revoke one paired gateway device and its live streams
compozy.gateway.revokeGatewayDevice({ path }) → Promise<GatewayRevokePayload>
Options
- idstringpathrequired
- Gateway device id
DELETE /api/gateway/devices/{id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.revokeGatewayDevice({ path: { "id": "id" } });setGatewaySurface
Set durable exposure for one gateway surface
compozy.gateway.setGatewaySurface({ body }) → Promise<GatewayStatusPayload>
Request bodyGatewaySurfaceRequest
POST /api/gateway/surfacesapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.setGatewaySurface({ body: { /* request fields */ } });unbindGatewayIngress
Remove one public ingress confirmation
compozy.gateway.unbindGatewayIngress({ path }) → Promise<GatewayIngressUnbindResponse>
Options
- subject_kindstringpathrequired
- Ingress subject kind
- subject_idstringpathrequired
- Ingress subject id
DELETE /api/gateway/ingress-bindings/{subject_kind}/{subject_id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.gateway.unbindGatewayIngress({ path: { "subject_kind": "subject_kind", "subject_id": "subject_id" } });