FWfw-ai-external
gateway.openapi_Gateway

Get Secret

Changed on

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}

Request

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

  • 311efdb2fa57Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      api tag gateway.openapi_Gateway added

    • info

      api tag Gateway removed