listAgentSecrets

GET

/api/v1/agents/{agentId}/secrets

listAgentSecrets

curl --request GET \
  --url '<base-url>/api/v1/agents/<agentId>/secrets' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/agents/<agentId>/secrets';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

[
  {
    "secret": {
      "id": "string",
      "workspaceId": "string",
      "name": "string",
      "rule": {
        "hosts": [
          "string"
        ],
        "header": "string",
        "template": "string"
      },
      "placeholder": "string",
      "owner": {
        "id": "string",
        "email": "string",
        "name": "string",
        "avatarUrl": "string"
      },
      "canManage": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "envVar": "string"
  }
]

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Returns

200

Secrets attached to the agent.

JSON

secret
object
required
- id
  string
  required
- workspaceId
  string
  required
- name
  string
  required
- rule
  object
  required
  hosts
  array of
  string
  required
  Exact host names or "*.example.com".
  
  header
  string
  required
  template
  string
  required
  Header value; {{.Value}} is the secret. Function: base64.
- placeholder
  string
  required
  What sandboxes see instead of the value.
- owner
  object
  required
  id
  string
  required
  email
  string
  required
  name
  string
  required
  avatarUrl
  string
  required
- canManage
  boolean
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
envVar
string
required

404

Error.

JSON

error
string
required