v1/gateway REST API Endpoint

Path Parameters

name

string

REQUIRED

The name of the gateway

isPrivate

boolean

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

isEnabled

boolean

A boolean value that indicates whether the new 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

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 new dedicated 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, the gateway is private and not publicly accessible. If set to false, 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

1
curl --location --request POST 'https://api.quicknode.com/ipfs/rest/v1/gateway' \
2
--header 'x-api-key: YOUR_API_KEY' \
3
--header 'Content-Type: application/json' \
4
--data-raw '  {
5
    "name": "YOUR_GATEWAY_NAME",
6
    "isPrivate": false,
7
    "isEnabled": false
8
  }'
9

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free