Creating a credential

Most external systems require authentication before VendorGate can read or write data. Credentials let you store those secrets in one place and reuse them across pipelines and monitors.

Before you create a credential

Make sure you have the connection details ready. For example:

  • An SFTP server needs a host, username, and password or private key.
  • An API credential may need an API key, bearer token, OAuth2 client credentials, mTLS certificate, or basic-auth username and password depending on the strategy.
  • A database needs a driver, host, port, database name, username, and password.
  • An LLM provider credential needs the provider name (for example openai or anthropic), model name, and API key.

Steps

  1. Go to Credentials.
  2. Click New Credential.
  3. Select the credential type that matches the system you want to reach.
  4. Enter a clear, descriptive name, such as Acme SFTP or Supplier API Key.
  5. Fill in the required fields for that credential type.
  6. Save.

Using the credential

When you create a pipeline source, delivery destination, or API monitor, choose the credential by name. VendorGate retrieves the secret at runtime, so the pipeline configuration only needs to know which credential to use.

Rotating a credential

When a password or key expires:

  1. Open the credential.
  2. Update the secret fields.
  3. Save.

All resources that reference the credential will use the updated value on their next run.

Naming tips

  • Use names that describe the system and purpose, for example Vendor A SFTP Inbound.
  • Avoid putting secrets in the credential name.
  • Use separate credentials for production and sandbox environments.