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,
sig/anthropic/resources/beta/vaults.rbs,
sig/anthropic/resources/beta/vaults/credentials.rbs

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:



208
209
210
211
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 208

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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsVault

Archive Vault

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

Parameters:

  • vault_id (String) —

    Path parameter vault_id

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

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

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

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

Returns:

See Also:



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 194

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", workspace_id: "anthropic-workspace-id"),
    model: Anthropic::Beta::BetaManagedAgentsVault,
    options: {extra_headers: {"anthropic-beta" => "managed-agents-2026-04-01"}, **options}
  )
end

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

Create Vault

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



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

def create(params)
  parsed, options = Anthropic::Beta::VaultCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
  @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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsDeletedVault

Delete Vault

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

Parameters:

  • vault_id (String) —

    Path parameter vault_id

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

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

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

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

Returns:

See Also:



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 165

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::BetaManagedAgentsVault>

List Vaults

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 129

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",
      workspace_id: "anthropic-workspace-id"
    ),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsVault

Get Vault

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

Parameters:

  • vault_id (String) —

    Path parameter vault_id

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

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

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

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

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 61

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", workspace_id: "anthropic-workspace-id"),
    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, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaManagedAgentsVault

Update Vault

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

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.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

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

Returns:

See Also:



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/anthropic/resources/beta/vaults.rb', line 94

def update(vault_id, params = {})
  parsed, options = Anthropic::Beta::VaultUpdateParams.dump_request(params)
  header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
  @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