Get the organization's secrets

GET https://runix.chat/api/v1/armada/secrets

Get the secrets the organization keeps for its runs: API keys, tokens and passwords, which every run of the agent gets as environment variables named after them. A value is never returned: only each secret's name, its note, the last four characters of a long one, who added and replaced it and when, and when a run last used it.

Guests and bots cannot use this endpoint.

Changes: New in Zulip 13.0 (feature level ZF-448986).

Usage examples

curl -sSX GET -G https://runix.chat/api/v1/armada/secrets \
    -u EMAIL_ADDRESS:API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

• secrets: (object)[]

  The organization's secrets, by name.

  • name: string

    The environment variable every run gets it in.

  • hint: string

    The last four characters of a value of 16 characters or more; empty for a shorter one.

  • note: string

    What the secret is for.

  • added_by: integer | null

    The ID of the user who added it, or null if they were deleted.

  • date_added: integer

    When it was added, as a UNIX timestamp.

  • replaced_by: integer | null

    The ID of the user who last gave it a new value, or null if no one has.

  • date_replaced: integer | null

    When it was last given a new value, as a UNIX timestamp, or null.

  • date_used: integer | null

    When a run was last started with it, as a UNIX timestamp, or null if none has been.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "secrets": [
        {
            "added_by": 11,
            "date_added": 1792230000,
            "date_replaced": null,
            "date_used": 1792233600,
            "hint": "7f3a",
            "name": "WANDB_API_KEY",
            "note": "The team's W&B account",
            "replaced_by": null
        }
    ]
}