List access bundles

cURL

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

const options = {method: 'GET'};

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

	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/access-bundles")

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

{
  "accessBundles": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "serviceCount": 123,
      "memberCount": 123,
      "hostPatterns": [
        "<string>"
      ],
      "servicesRequiringSetup": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "description": "<string>"
    }
  ],
  "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

access-bundles

cURL

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

const options = {method: 'GET'};

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

	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/access-bundles")

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

{
  "accessBundles": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "serviceCount": 123,
      "memberCount": 123,
      "hostPatterns": [
        "<string>"
      ],
      "servicesRequiringSetup": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "description": "<string>"
    }
  ],
  "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

requiresSetup

enum<string>

true lists only the access bundles you can reach that have services still requiring your personal values. false lists the rest of them. Omit to list them all.

Available options:

true,

false

granted

enum<string>

true lists only the access bundles granted to you, directly or through a group. false lists the ones you reach only as an admin. Omit to list them all.

Available options:

true,

false

orderBy

enum<string>

default:createdAt

What to sort access bundles by: name, serviceCount or createdAt.

Available options:

name,

serviceCount,

createdAt

orderDirection

enum<string>

default:desc

Which way to sort: asc or desc.

Available options:

asc,

desc

onBehalfOfUserId

string<uuid>

List the access bundles a session on behalf of this user could use: those both the user and your machine identity can use. requiresSetup and servicesRequiringSetup then refer to the user's personal values. Only a machine identity whose delegation covers the user can do this, and granted can't be combined with it. Set this or onBehalfOfUserEmail, not both.

onBehalfOfUserEmail

string<email>

Like onBehalfOfUserId, naming the user by email address instead. Set this or onBehalfOfUserId, not both.

Maximum string length: 255

string

Match access bundles by name or description.

Maximum string length: 255

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

limit

integer

default:20

The maximum number of access bundles to return.

Required range: 1 <= x <= 100

offset

integer

default:0

How many access bundles to skip.

Required range: 0 <= x <= 10000

projectId

string

The ID of the Agent Vault project.

Required string length: 1 - 36

Response

Default Response

accessBundles

object[]

required

Show child attributes

totalCount

number

required

Get started

Organization

Project

Shared

Identity auth

Secrets Management

Certificate Management

Secret sharing

Agent Vault

Key Management Service (KMS)

KMIP servers

Gateways

External migrations

Other

List access bundles

Query Parameters

Response