Skip to main content

v1/gateway REST API Endpoint

Returns a list of all dedicated gateways.

Updated on
Oct 19, 2023

v1/gateway REST API Endpoint

Parameters

This method does not accept any parameters

Returns

result
object
An array that returns a list of all dedicated gateways
id
integer
An integer that represents the unique identifier of a dedicated gateway
uuid
string
A string that represents the universally unique identifier (UUID) of the dedicated gateway. UUIDs are used to identify resources uniquely
createdAt
string
The date and time when the dedicated gateway was created
updatedAt
string
The date and time when the dedicated gateway was last updated
qnAccountId
string
The Quicknode account id
name
string
A string that specifies the name of the dedicated 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 dedicated 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 dedicated 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
cnameRecordId
string
The canonical name record id
Request
1
curl --location --request GET 'https://api.quicknode.com/ipfs/rest/v1/gateway' \
2
--header 'x-api-key: YOUR_API_KEY'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free