Class: Anthropic::Resources::Beta::Vaults

Inherits:
Object
  • Object
show all
Defined in:
lib/anthropic/resources/beta/vaults.rb,
lib/anthropic/resources/beta/vaults/credentials.rb

Defined Under Namespace

Classes: Credentials

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Vaults

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Vaults.

Parameters:



184
185
186
187
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 184

def initialize(client:)
  @client = client
  @credentials = Anthropic::Resources::Beta::Vaults::Credentials.new(client: client)
end

Instance Attribute Details

#credentials ⇒ Anthropic::Resources::Beta::Vaults::Credentials (readonly)

Returns:



8
9
10
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 8

def credentials
  @credentials
end

Instance Method Details

#archive(vault_id, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsVault

Archive Vault

Parameters:

Returns:

See Also:



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 170

def archive(vault_id, params = {})
  parsed, options = Anthropic::Beta::VaultArchiveParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/vaults/%1$s/archive?beta=true", vault_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::BetaManagedAgentsVault,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#create(display_name:, metadata: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsVault

Some parameter documentations has been truncated, see Models::Beta::VaultCreateParams for more details.

Create Vault

Parameters:

  • display_name (String) —

    Body param: Human-readable name for the vault. 1-255 characters.

  • metadata (Hash{Symbol=>String}) —

    Body param: Arbitrary key-value metadata to attach to the vault. Maximum 16 pair

  • betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

    Header param: Optional header to specify the beta version(s) you want to use.

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 28

def create(params)
  parsed, options = Anthropic::Beta::VaultCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta"}
  @client.request(
    method: :post,
    path: "v1/vaults?beta=true",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::BetaManagedAgentsVault,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#delete(vault_id, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsDeletedVault

Delete Vault

Parameters:

Returns:

See Also:



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 146

def delete(vault_id, params = {})
  parsed, options = Anthropic::Beta::VaultDeleteParams.dump_request(params)
  @client.request(
    method: :delete,
    path: ["v1/vaults/%1$s?beta=true", vault_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::BetaManagedAgentsDeletedVault,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#list(include_archived: nil, limit: nil, page: nil, betas: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::BetaManagedAgentsVault>

Some parameter documentations has been truncated, see Models::Beta::VaultListParams for more details.

List Vaults

Parameters:

  • include_archived (Boolean) —

    Query param: Whether to include archived vaults in the results.

  • limit (Integer) —

    Query param: Maximum number of vaults to return per page. Defaults to 20, maximu

  • page (String) —

    Query param: Opaque pagination token from a previous ‘list_vaults` response.

  • betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

    Header param: Optional header to specify the beta version(s) you want to use.

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 118

def list(params = {})
  query_params = [:include_archived, :limit, :page]
  parsed, options = Anthropic::Beta::VaultListParams.dump_request(params)
  query = Anthropic::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: "v1/vaults?beta=true",
    query: query,
    headers: parsed.except(*query_params).transform_keys(betas: "anthropic-beta"),
    page: Anthropic::Internal::PageCursor,
    model: Anthropic::Beta::BetaManagedAgentsVault,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#retrieve(vault_id, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsVault

Get Vault

Parameters:

Returns:

See Also:



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 54

def retrieve(vault_id, params = {})
  parsed, options = Anthropic::Beta::VaultRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/vaults/%1$s?beta=true", vault_id],
    headers: parsed.transform_keys(betas: "anthropic-beta"),
    model: Anthropic::Beta::BetaManagedAgentsVault,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

#update(vault_id, display_name: nil, metadata: nil, betas: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsVault

Some parameter documentations has been truncated, see Models::Beta::VaultUpdateParams for more details.

Update Vault

Parameters:

  • vault_id (String) —

    Path param: Path parameter vault_id

  • display_name (String, nil) —

    Body param: Updated human-readable name for the vault. 1-255 characters.

  • metadata (Hash{Symbol=>String, nil}, nil) —

    Body param: Metadata patch. Set a key to a string to upsert it, or to null to de

  • betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) —

    Header param: Optional header to specify the beta version(s) you want to use.

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 85

def update(vault_id, params = {})
  parsed, options = Anthropic::Beta::VaultUpdateParams.dump_request(params)
  header_params = {betas: "anthropic-beta"}
  @client.request(
    method: :post,
    path: ["v1/vaults/%1$s?beta=true", vault_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::BetaManagedAgentsVault,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end