Skip to content
Hayonix

API reference · Secrets

Get a secret (metadata only)

GET/v1/secrets/{secret_id}
API keysecret:readProject
TypeScript
client.secrets.get()
Python
client.secrets.get()
CLI
hayonix secrets show

Returns the secret’s name and dates; the value is never returned.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the secret:read permission (a key's scope, or a role that includes it).

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

curl -sS "$API_BASE_URL/secrets/sec_01jc5zq4m8k3v6x9t2w7r0b1e4" \
  -H "Authorization: Bearer $API_KEY"

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Path parameters

  • secret_idstringrequired

    ID of the secret

    ID with prefix sec_

Response

200 Secret — The secret

  • objectstringrequired

    Always `secret`: the type of this object

    One ofsecret

  • idstringrequired

    Unique ID (`sec_…`)

    ID with prefix sec_

  • project_idstringrequired

    Project it belongs to

    ID with prefix prj_

  • namestringrequired

    Its name

  • created_by_user_idstring | nullrequired

    ID of the user who created it

  • created_byobject | nullrequired

    Who created it (null: created by the platform)

    Show 3 fields of created_by
    • objectstringrequired

      Always `person`

      One ofperson

    • idstringrequired

      The person’s user ID (`usr_…`)

    • namestring | nullrequired

      Their name as they set it; null when they are no longer a member of the organization

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

  • updated_atstring (date-time)required

    When it last changed (ISO 8601, UTC)

Example response
Example response
{
  "object": "secret",
  "id": "sec_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "name": "string",
  "created_by_user_id": "string",
  "created_by": {
    "object": "person",
    "id": "string",
    "name": "string"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.