Skip to main content

v1/gateway/{gatewayName} REST API Endpoint

Returns details about the specified gateway (e.g. name, public vs private, enabled vs disabled).

Updated on
Oct 19, 2023

Path Parameters

gatewayName
string
REQUIRED

The name of the gateway

Returns

id
integer

An integer that represents the unique identifier of a specified gateway

uuid
string

A string that represents the universally unique identifier (UUID) of the specified gateway. UUIDs are used to identify resources uniquely

createdAt
string

The date and time when the specified gateway was created

updatedAt
string

The date and time when the specified gateway was last updated

name
string

A string that specifies the name of the specified gateway. It is a human-readable identifier for the gateway

domain
string

The domain associated with the gateway

status
string

The status of the gateway

isPrivate
boolean

A boolean value that indicates whether the specified gateway is private or not. If set to true, it means the gateway is private and not publicly accessible. If set to false, it means the gateway is public and can be accessed by authorized users

isEnabled
boolean

A boolean value that indicates whether the specified gateway is enabled or not. If set to true, it means the gateway is currently enabled and operational. If set to false, it means the gateway is disabled and not functioning

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free