Skip to content

Provider Connections

Generated TypeScript Management SDK methods for Provider Connections.

Updated View as Markdown
Audience: application-backendPlane: adminAuth: management-keyStatus: beta

These methods are generated from the Admin OpenAPI contract. They configure the control plane; they do not send model requests.

Method HTTP Path Reference
archiveProviderConnection DELETE /admin/v1/provider-connections/{providerConnectionId} API
createProviderConnection POST /admin/v1/workspaces/{workspaceId}/provider-connections API
getProviderConnection GET /admin/v1/provider-connections/{providerConnectionId} API
listProviderConnections GET /admin/v1/workspaces/{workspaceId}/provider-connections API
rotateProviderSecret POST /admin/v1/provider-connections/{providerConnectionId}/rotate-secret API
testProviderConnection POST /admin/v1/workspaces/{workspaceId}/provider-connections/test API
updateProviderConnection PATCH /admin/v1/provider-connections/{providerConnectionId} API
verifyProviderConnection POST /admin/v1/provider-connections/{providerConnectionId}/verify API

Method signatures

archiveProviderConnection

nexus.archiveProviderConnection(
  input: AdminOperationInput<"archiveProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"archiveProviderConnection">>

Archive a provider connection

createProviderConnection

nexus.createProviderConnection(
  input: AdminOperationInput<"createProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createProviderConnection">>

Connect an upstream provider and encrypted API key

getProviderConnection

nexus.getProviderConnection(
  input: AdminOperationInput<"getProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getProviderConnection">>

Get a provider connection without secret plaintext

listProviderConnections

nexus.listProviderConnections(
  input: AdminOperationInput<"listProviderConnections">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listProviderConnections">>

List provider connections

rotateProviderSecret

nexus.rotateProviderSecret(
  input: AdminOperationInput<"rotateProviderSecret">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"rotateProviderSecret">>

Rotate a provider API key

testProviderConnection

nexus.testProviderConnection(
  input: AdminOperationInput<"testProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"testProviderConnection">>

Test provider connectivity and credentials before saving

updateProviderConnection

nexus.updateProviderConnection(
  input: AdminOperationInput<"updateProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"updateProviderConnection">>

Update a provider connection

verifyProviderConnection

nexus.verifyProviderConnection(
  input: AdminOperationInput<"verifyProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"verifyProviderConnection">>

Verify provider connectivity and credentials

Navigation

Type to search…

↑↓ navigate↵ selectEsc close