Get one secret

Get one secret by its unique name

get/secret/{name}

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/secret/:name/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Unique name of the secret

Response

Secret information

result'success' | 'error' required

Result of the request

action'getSecret' required

The id of the action

Example response

{
  "data": {
    "secrets": [
      {
        "name": "secret-password",
        "description": "Password of my super secret user account"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 7 revisions of this API.