List Credentials

Updated at:

Paginated list of all Credentials under a specified Vault.

Prerequisites

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

Endpoint

GET /vaults/{vault_id}/credentials

Path parameters

FieldRequiredTypeDescription
vault_idYesstringVault ID, format vlt_xxx

Query parameters

FieldRequiredTypeDescription
include_archivedNobooleanWhether to include archived Credentials; default false
limitNointegerNumber of items per page; default 20, max 100
pageNostringPagination 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

FieldTypeDescription
dataarray<object>Array of Credential objects
data[].idstringCredential ID, format cred_xxx
data[].typestringAlways credential
data[].vault_idstringVault ID that the Credential belongs to
data[].display_namestringHuman-readable name of the Credential
data[].authobjectAuthentication information with sensitive values masked
data[].metadataobjectCustom key-value pairs
data[].archived_atstring | nullArchive timestamp; null if not archived
data[].created_atstringCreation time, ISO 8601
data[].updated_atstringLast update time, ISO 8601
data[].request_idstringUnique request identifier
next_pagestring | nullNext page cursor; null when there is no more data

Error codes

HTTP statusError codeDescription
400InvalidParameterRequired parameter missing or invalid
401InvalidApiKeyInvalid API key provided