Sign in
gateway.openapi_Gateway

Get Secret

Retrieves a secret by name. Note that the value field is not returned in the response for security reasons. Only the name and key_name fields are included.

get/v1/accounts/{account_id}/secrets/{secret_id}

Path parameters

account_idstring required

The Account Id

secret_idstring required

The Secret Id

Query parameters

readMaskstring

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

A successful response.

namestring required
keyNamestring required
valuestring

The secret value. This field is INPUT_ONLY and will not be returned in GET or LIST responses for security reasons. The value is only accepted when creating or updating secrets.

Example response

{
  "value": "sk-1234567890abcdef"
}

Changes

Changed in 1 of the 27 revisions of this API.3

  • 311efdb2fa573See the full diff
    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      api tag gateway.openapi_Gateway added

      api-tag-added

    • ○

      api tag Gateway removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog