Universal Secrets Connector

POST /usc-get

Request

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

Request body

aws-account-idstring

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

gcp-project-idstring

The GCP project the secret resides in (GCP only). Used when getting a secret by name in a connector that spans multiple projects or uses folder/organization scope.

jsonboolean

Set output format to JSON

namespacestring

The namespace (relevant for Hashi vault target)

object-typestring
regionstring

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

secret-idstring required

The secret id (or name, for AWS, Azure, K8s or Hashi vault targets) to get from the Universal Secrets Connector

selected-repositoriesstring

GitHub selected repositories. For repository scope: repo name. For repository-environment scope: repo/env (format: repo-name/env-name). Required when multiple repos/envs configured.

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

usc-namestring required

Name of the Universal Secrets Connector item

version-idstring

The version id (if not specified, will retrieve the last version)

Response

uscGetResponse wraps response body.

activation_datestring date-time
binary_valueboolean
encryption_keystring
expirationstring date-time
idstring
metadataunknown
namestring
valuestring
version_idstring
version_idsstring[]
warningsstring[]

Changes

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