List proxies

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/agent-vault/proxies

const options = {method: 'GET'};

fetch('https://us.infisical.com/api/v1/agent-vault/proxies', 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://us.infisical.com/api/v1/agent-vault/proxies",
  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://us.infisical.com/api/v1/agent-vault/proxies"

	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://us.infisical.com/api/v1/agent-vault/proxies")

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

{
  "proxies": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "heartbeat": "2023-11-07T05:31:56Z",
      "isHealthy": true,
      "rootCaFingerprint": "<string>",
      "rootCaExpiresAt": "2023-11-07T05:31:56Z",
      "trafficPolicy": "any-host",
      "allowedHosts": "<string>",
      "pollInterval": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalCount": 123
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

GET

api

agent-vault

proxies

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/agent-vault/proxies

const options = {method: 'GET'};

fetch('https://us.infisical.com/api/v1/agent-vault/proxies', 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://us.infisical.com/api/v1/agent-vault/proxies",
  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://us.infisical.com/api/v1/agent-vault/proxies"

	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://us.infisical.com/api/v1/agent-vault/proxies")

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

{
  "proxies": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "heartbeat": "2023-11-07T05:31:56Z",
      "isHealthy": true,
      "rootCaFingerprint": "<string>",
      "rootCaExpiresAt": "2023-11-07T05:31:56Z",
      "trafficPolicy": "any-host",
      "allowedHosts": "<string>",
      "pollInterval": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalCount": 123
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Query Parameters

orderBy

enum<string>

default:createdAt

What to sort proxies by: name or createdAt.

Available options:

name,

createdAt

orderDirection

enum<string>

default:desc

Which way to sort: asc or desc.

Available options:

asc,

desc

string

Match proxies by name.

Maximum string length: 255

Pattern: ^[^\x00-\x1f\x7f]*$

limit

integer

default:20

The maximum number of proxies to return.

Required range: 1 <= x <= 100

offset

integer

default:0

How many proxies to skip.

Required range: 0 <= x <= 10000

Response

Default Response

proxies

(Admin view · object | Member view · object)[]

required

Admin view
Member view

Show child attributes

totalCount

number

required

Get started

Organization

Project

Shared

Identity auth

Secrets management

Certificate management

Secret scanning

Secret sharing

Infisical KMS

Agent Vault

KMIP servers

Gateways

External migrations

Other

Query Parameters

Response