Universal Secrets Connector

POST /usc-create

Request

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

Request body

aws-account-idstring

The AWS account ID to create the secret in. 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

gcp-project-idstring

The GCP project to create the secret in (GCP only). Required when the connector spans multiple projects or uses folder/organization scope.

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

AWS Organization scope region or GCP regional secret location. GCP creates a global secret when empty.

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-namestring required

Name for the new universal secrets

selected-repositoriesstring
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

uscCreateResponse wraps response body.

partial_failurestring

PartialFailure aggregates per-target create failures when some targets still succeeded.

secret_idstring
selected_environmentsstring

SelectedEnvironments is the subset of GitHub environments where create succeeded (comma-separated).

selected_repositoriesstring

SelectedRepositories is the subset of GitHub repositories where create succeeded (comma-separated).

version_idstring

Changes

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