List Credentials

Prerequisites

Endpoint and authentication configured. For details, see Overview and authentication.

Endpoint

GET /vaults/{vault_id}/credentials

Path parameters

Field	Required	Type	Description
`vault_id`	Yes	string	Vault ID, format `vlt_xxx`

Query parameters

Field	Required	Type	Description
`include_archived`	No	boolean	Whether to include archived Credentials; default `false`
`limit`	No	integer	Number of items per page; default 20, max 100
`page`	No	string	Pagination cursor; take from the `next_page` value of the previous response

Request example

curl -X GET "$AGENTSTUDIO_URL/vaults/vlt_xxx/credentials?limit=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response example

{
  "data": [
    {
      "id": "cred_xxx",
      "type": "credential",
      "vault_id": "vlt_xxx",
      "display_name": "Third-party API key",
      "auth": {
        "type": "environment_variable",
        "secret_name": "API_KEY",
        "networking": {
          "allowed_hosts": [
            "api.example.com",
            "*.example.com"
          ]
        },
        "injection_location": {
          "header": true
        }
      },
      "metadata": {},
      "archived_at": null,
      "created_at": "2026-07-10T08:00:00Z",
      "updated_at": "2026-07-10T08:00:00Z",
      "request_id": "req_xxx"
    }
  ],
  "next_page": null
}

Response fields

Field	Type	Description
`data`	array<object>	Array of Credential objects
`data[].id`	string	Credential ID, format `cred_xxx`
`data[].type`	string	Always `credential`
`data[].vault_id`	string	Vault ID that the Credential belongs to
`data[].display_name`	string	Human-readable name of the Credential
`data[].auth`	object	Authentication information with sensitive values masked
`data[].metadata`	object	Custom key-value pairs
`data[].archived_at`	string \| null	Archive timestamp; `null` if not archived
`data[].created_at`	string	Creation time, ISO 8601
`data[].updated_at`	string	Last update time, ISO 8601
`data[].request_id`	string	Unique request identifier
`next_page`	string \| null	Next page cursor; `null` when there is no more data

Error codes

HTTP status	Error code	Description
400	`InvalidParameter`	Required parameter missing or invalid
401	`InvalidApiKey`	Invalid API key provided

​Prerequisites

​Endpoint

​Path parameters

​Query parameters

​Request example

​Response example

​Response fields

​Error codes

Prerequisites

Endpoint

Path parameters

Query parameters

Request example

Response example

Response fields

Error codes