List Credential Profiles
cnc_list_credential_profilesLists credential profiles known to Crosswork with optional name filter and paging so you can find profile names for devices or providers and check covered protocols like SSH, HTTP, and SNMPv2.
Instructions
List credential profiles known to Crosswork, with optional name filter and paging.
Read-only. Use it to find the profile name to reference when adding devices or providers, or to check which protocols (SSH/HTTP/HTTPS/SNMPv2/...) a profile covers. For one profile's full record use cnc_get_credential_profile.
Secrets are masked by the API ("******"); usernames are returned in clear.
Args: profile: name filter (exact, case-insensitive, '*' wildcard; surrounding whitespace is stripped and a blank filter means no filter). page_size / page: filterData paging (0-based page). response_format: 'markdown' (default) or 'json'.
Returns: str: Markdown "- profile — types: SSH (user), HTTP (user), SNMPv2" lines, or JSON: {"total": int|null, "count": int, "page": int, "page_size": int, "items": [{"profile": str, "user_pass": [{"user_name": str, "password": "", "type": "ROBOT_USERPASS_SSH|HTTP|HTTPS|..."}], "v2_info": {"read_community": "", ...}?}, ...], "has_more": bool, "next_page": int|null, "collection_total": int|null} "total" is the number of profiles matching the filter (null when the platform omits it, i.e. zero matches); "collection_total" is the size of the whole collection regardless of filter. On failure: "Error: " (500 "NATS request failed" -> the query body was rejected; 403 -> token rejected or missing privilege).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 0-based page number (e.g. 0). | |
| profile | No | Filter by profile name: exact match, case-insensitive, '*' is a wildcard (e.g. 'nso', 'cml-*', '*xrd'). No filter lists every profile. | |
| page_size | No | Profiles per page (e.g. 20). | |
| response_format | No | 'markdown' for human-readable output, 'json' for complete data. | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |