Get the deployment's egress IP addresses

Get the deployment's egress addresses

curl --request GET \
  --url https://api.onecli.sh/v1/instance/egress

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onecli.sh/v1/instance/egress",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/v1/instance/egress"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/instance/egress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "syncToken": "<string>",
  "createDate": "2023-11-07T05:31:56Z",
  "prefixes": [
    {
      "ip_prefix": "<string>",
      "region": "<string>",
      "service": "ONECLI_EGRESS",
      "effective": "<string>",
      "expires": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

GET

instance

egress

Get the deployment's egress addresses

curl --request GET \
  --url https://api.onecli.sh/v1/instance/egress

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onecli.sh/v1/instance/egress",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/v1/instance/egress"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/instance/egress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "syncToken": "<string>",
  "createDate": "2023-11-07T05:31:56Z",
  "prefixes": [
    {
      "ip_prefix": "<string>",
      "region": "<string>",
      "service": "ONECLI_EGRESS",
      "effective": "<string>",
      "expires": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

Returns the deployment’s outbound addresses. Use them to allowlist OneCLI in your firewall. Self-hosted deployments answer 404 unless the operator set a list. Related guide: Self-hosting overview. The source addresses this deployment calls out from, for allowlisting on your side. Published by OneCLI Cloud; a self-hosted deployment answers 404 unless its operator configured a list. No authentication; cacheable for an hour.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Response

The feed

The addresses this deployment calls out from, in the shape of AWS's ip-ranges.json.

syncToken

string

Changes exactly when the list does.

createDate

string<date-time>

prefixes

object[]

Show child attributes

Workspace

Organization

Enterprise

Platform

Get the deployment's egress IP addresses

Response