Universal Secrets Connector

POST /usc-update

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/usc-update
  • Auth
    none declared

Request body

aws-account-idstring

The AWS account ID that contains the secret. Required when the connector spans multiple account IDs.

binary-valueboolean

Use this option if the universal secrets value is a base64 encoded binary

descriptionstring

Description of the universal secrets

jsonboolean

Set output format to JSON

namespacestring

The namespace (relevant for Hashi vault target)

object-typestring
pfx-passwordstring

Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)

regionstring

The AWS region that contains the secret (AWS only). If empty, uses the target region.

remote-secret-activation-datestring

Activation date for the secret on the remote endpoint, in UTC format: YYYY-MM-DDTHH:MM:SSZ

remote-secret-expiresstring

Expiration time for the secret on the remote endpoint, in UTC format: YYYY-MM-DDTHH:MM:SSZ

secret-idstring required

The universal secrets id (or name, for AWS, Azure, K8s or Hashi vault targets) to update

selected-repositoriesstring

GitHub selected repositories (required for GitHub USC when repository-access is 'selected' or for repository scope) Comma-separated repository names (e.g., "repo1,repo2")

tagsobject

Tags for the universal secrets

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

usc-encryption-keystring

Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)

usc-namestring required

Name of the Universal Secrets Connector item

valuestring required

Value of the universal secrets item, either text or base64 encoded binary

Response

uscUpdateResponse wraps response body.

namestring
secret_idstring
version_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.