客户 API v1(已弃用)
添加 IP 白名单
Add an IP address to the whitelist for a given license and location.
POST
/
customer
/
v1
/
licenses
/
{license}
/
whitelist-ip
Whitelist an IP (v1)
curl --request POST \
--url https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip \
--header 'Content-Type: application/json' \
--header 'X-ORBIT-KEY: <api-key>' \
--data '
{
"ip_address": "127.0.0.1",
"location_id": 123,
"expires_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip"
payload = {
"ip_address": "127.0.0.1",
"location_id": 123,
"expires_at": "2023-11-07T05:31:56Z"
}
headers = {
"X-ORBIT-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-ORBIT-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ip_address: '127.0.0.1', location_id: 123, expires_at: '2023-11-07T05:31:56Z'})
};
fetch('https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ip_address' => '127.0.0.1',
'location_id' => 123,
'expires_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-ORBIT-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip"
payload := strings.NewReader("{\n \"ip_address\": \"127.0.0.1\",\n \"location_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-ORBIT-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip")
.header("X-ORBIT-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ip_address\": \"127.0.0.1\",\n \"location_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-ORBIT-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ip_address\": \"127.0.0.1\",\n \"location_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"error": true,
"message": "<string>"
}{
"error": true,
"message": "<string>"
}已弃用。 此接口属于 Customer API v1。请使用 Customer API v2 替代。
授权
API key for v1 and v2 (when not using Bearer token)
路径参数
The license identifier.
请求体
application/json
IP address and location ID to whitelist.
响应
IP whitelisted successfully.
此页面对您有帮助吗?
⌘I
Whitelist an IP (v1)
curl --request POST \
--url https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip \
--header 'Content-Type: application/json' \
--header 'X-ORBIT-KEY: <api-key>' \
--data '
{
"ip_address": "127.0.0.1",
"location_id": 123,
"expires_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip"
payload = {
"ip_address": "127.0.0.1",
"location_id": 123,
"expires_at": "2023-11-07T05:31:56Z"
}
headers = {
"X-ORBIT-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-ORBIT-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ip_address: '127.0.0.1', location_id: 123, expires_at: '2023-11-07T05:31:56Z'})
};
fetch('https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ip_address' => '127.0.0.1',
'location_id' => 123,
'expires_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-ORBIT-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip"
payload := strings.NewReader("{\n \"ip_address\": \"127.0.0.1\",\n \"location_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-ORBIT-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip")
.header("X-ORBIT-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ip_address\": \"127.0.0.1\",\n \"location_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://orbitflare.com/api/customer/v1/licenses/{license}/whitelist-ip")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-ORBIT-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ip_address\": \"127.0.0.1\",\n \"location_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"error": true,
"message": "<string>"
}{
"error": true,
"message": "<string>"
}