Path Parameters

gatewayName

string

REQUIRED

the name of the gateway to be updated

Body Parameters

isEnabled

boolean

REQUIRED

A boolean value indicating whether the gateway should be enabled or disabled

isPrivate

boolean

REQUIRED

A boolean value indicating whether the gateway should be set as private or public

Returns

name

string

The name of the gateway

isPrivate

boolean

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

isEnabled

boolean

A boolean value indicating whether the gateway is enabled or disabled. If true, it means the gateway is currently enabled and operational. If false, it means the gateway is disabled and not functioning

id

integer

The unique identifier of the gateway

domain

string

The domain associated with the gateway

status

string

The status of the gateway

uuid

string

The universally unique identifier (UUID) of the gateway. UUIDs are used to identify resources uniquely

createdAt

string

The date and time when the gateway was created

updatedAt

string

The date and time when the gateway was last updated

Request

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

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

1
var myHeaders = new Headers();
2
myHeaders.append("x-api-key", "YOUR_API_KEY");
3
myHeaders.append("Content-Type", "application/json");
4

5
var raw = JSON.stringify({
6
  "isEnabled": true,
7
  "isPrivate": true
8
});
9

10
var requestOptions = {
11
  method: 'PATCH',
12
  headers: myHeaders,
13
  body: raw,
14
  redirect: 'follow'
15
};
16

17
fetch("https://api.quicknode.com/ipfs/rest/v1/gateway/{gatewayName}", requestOptions)
18
  .then(response => response.text())
19
  .then(result => console.log(result))
20
  .catch(error => console.log('error', error));
21

1
var myHeaders = new Headers();
2
myHeaders.append("x-api-key", "YOUR_API_KEY");
3
myHeaders.append("Content-Type", "application/json");
4

5
var raw = JSON.stringify({
6
  "isEnabled": true,
7
  "isPrivate": true
8
});
9

10
var requestOptions = {
11
  method: 'PATCH',
12
  headers: myHeaders,
13
  body: raw,
14
  redirect: 'follow'
15
};
16

17
fetch("https://api.quicknode.com/ipfs/rest/v1/gateway/{gatewayName}", requestOptions)
18
  .then(response => response.text())
19
  .then(result => console.log(result))
20
  .catch(error => console.log('error', error));
21

1
import requests
2
import json
3

4
url = "https://api.quicknode.com/ipfs/rest/v1/gateway/{gatewayName}"
5

6
payload = json.dumps({
7
  "isEnabled": True,
8
  "isPrivate": True
9
})
10
headers = {
11
  'x-api-key': 'YOUR_API_KEY',
12
  'Content-Type': 'application/json'
13
}
14

15
response = requests.request("PATCH", url, headers=headers, data=payload)
16

17
print(response.text)
18

1
import requests
2
import json
3

4
url = "https://api.quicknode.com/ipfs/rest/v1/gateway/{gatewayName}"
5

6
payload = json.dumps({
7
  "isEnabled": True,
8
  "isPrivate": True
9
})
10
headers = {
11
  'x-api-key': 'YOUR_API_KEY',
12
  'Content-Type': 'application/json'
13
}
14

15
response = requests.request("PATCH", url, headers=headers, data=payload)
16

17
print(response.text)
18

1
require "uri"
2
require "json"
3
require "net/http"
4

5
url = URI("https://api.quicknode.com/ipfs/rest/v1/gateway/{gatewayName}")
6

7
https = Net::HTTP.new(url.host, url.port)
8
https.use_ssl = true
9

10
request = Net::HTTP::Patch.new(url)
11
request["x-api-key"] = "YOUR_API_KEY"
12
request["Content-Type"] = "application/json"
13
request.body = JSON.dump({
14
  "isEnabled": true,
15
  "isPrivate": true
16
})
17

18
response = https.request(request)
19
puts response.read_body
20

1
require "uri"
2
require "json"
3
require "net/http"
4

5
url = URI("https://api.quicknode.com/ipfs/rest/v1/gateway/{gatewayName}")
6

7
https = Net::HTTP.new(url.host, url.port)
8
https.use_ssl = true
9

10
request = Net::HTTP::Patch.new(url)
11
request["x-api-key"] = "YOUR_API_KEY"
12
request["Content-Type"] = "application/json"
13
request.body = JSON.dump({
14
  "isEnabled": true,
15
  "isPrivate": true
16
})
17

18
response = https.request(request)
19
puts response.read_body
20

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free