---
title: "List all Credentials"
method: GET
path: "/api/v1/credentials"
tags: ["Credentials"]
---

# List all Credentials

`GET /api/v1/credentials`

Returns all credentials in the authenticated user's organization.
Optionally filter by type (e.g. `?type=SnmpV2c`).

## Query parameters

- `type` 'SnmpV1' | 'SnmpV2c' | 'SnmpV3' | 'DockerProxy' | 'DockerSocket' | 'PodmanProxy' | 'PodmanSocket' | 'UnifiApiKey' | 'UnifiLocalAdmin' | 'InstantOnAccount'
- `group_by` 'created_at' | 'name' | 'updated_at'
- `order_by` 'created_at' | 'name' | 'updated_at'
- `order_direction` 'asc' | 'desc' — Direction for ORDER BY clauses.
- `limit` integer, nullable
- `offset` integer, nullable

## Response `200`

List of credentials

- PaginatedApiResponseCredential — Response type for paginated list endpoints (pagination is always present in meta)
  - `data` object[], required — The page of results. Empty when nothing matched the query.
    - `assigned_network_ids` string[], required — Networks this credential is assigned to (Broadcast scope). Hydrated from the `network_credentials` junction table.
    - `credential_type` union, required — Universal credential type — tagged enum stored as JSONB. Each variant represents a different credential protocol/method.
      - object — SNMPv1 community string — for legacy devices that only speak v1.
        - `community` union, required — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `type` 'SnmpV1', required
      - object — SNMPv2c community string for querying network devices
        - `community` union, required — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `type` 'SnmpV2c', required
      - object — SNMPv3 USM AuthPriv — security name + auth/priv protocols and passwords.
        - `auth_password` union, required — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `auth_protocol` 'Sha1' | 'Sha256', required — SNMPv3 USM authentication protocol. Variants are limited to the modern, secure set Scanopy supports; MD5 / SHA-2 variants beyond these are intentionally excluded. Serialized form (e.g. "Sha256") is the wire value stored in the credential and used as the frontend select option value.
        - `context_name` string, nullable — Optional context name (default/empty context used if unset).
        - `priv_password` union, required — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `priv_protocol` 'Aes128' | 'Aes256', required — SNMPv3 USM privacy (encryption) protocol.
        - `security_name` string, required — USM security (user) name.
        - `type` 'SnmpV3', required
      - object — Docker API proxy credentials. Target IP determined from host ip_addresses at scan time.
        - `path` string, nullable — Optional URL path prefix (e.g. "/v1.43")
        - `port` integer — Port for the Docker API proxy (default 2375)
        - `ssl_cert` union — Non-secret value that can be inline content or a file path on daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The value itself.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the value.
        - `ssl_chain` union — Non-secret value that can be inline content or a file path on daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The value itself.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the value.
        - `ssl_key` union — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `type` 'DockerProxy', required
      - object — Local Docker socket access on the daemon host. `socket_path` optionally repoints the socket (non-default `DOCKER_HOST`); blank ⇒ the daemon auto-detects (bollard defaults).
        - `socket_path` string, nullable — Path to the Docker socket. Blank lets the daemon auto-detect it.
        - `type` 'DockerSocket', required
      - object — Podman API proxy credentials. Podman exposes a Docker-compatible REST API, so the fields mirror `DockerProxy`. Target IP determined from host ip_addresses at scan time.
        - `path` string, nullable — Optional URL path prefix (e.g. "/v1.43")
        - `port` integer — Port for the Podman API proxy (default 2375)
        - `ssl_cert` union — Non-secret value that can be inline content or a file path on daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The value itself.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the value.
        - `ssl_chain` union — Non-secret value that can be inline content or a file path on daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The value itself.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the value.
        - `ssl_key` union — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `type` 'PodmanProxy', required
      - object — Local Podman socket access on the daemon host. `socket_path` optionally repoints the socket (e.g. rootful `/run/podman/podman.sock` vs rootless `$XDG_RUNTIME_DIR/podman/podman.sock`); blank ⇒ the daemon auto-detects via `resolve_podman_socket_path()`.
        - `socket_path` string, nullable — Path to the Podman socket. Blank lets the daemon auto-detect it.
        - `type` 'PodmanSocket', required
      - object — UniFi Network Application (controller) via an API key. **UniFi OS only** — a UniFi OS console (443) or UniFi OS Server (11443). The legacy self-hosted Network Application on 8443 does not support API keys; use [`CredentialType::UnifiLocalAdmin`] there.
        - `api_key` union, required — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `port` integer — Controller HTTPS port. 443 for a UniFi OS console, 11443 for UniFi OS Server.
        - `site` string — Internal site name from the controller URL (`/manage/site/<name>`).
        - `type` 'UnifiApiKey', required
      - object — UniFi Network Application (controller) via a local-admin account. Works on every controller type, including the legacy self-hosted Network Application on 8443. Use a local-only admin account so MFA does not block the login.
        - `password` union, required — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `port` integer — Controller HTTPS port. 443 UniFi OS console, 11443 UniFi OS Server, 8443 legacy.
        - `site` string — Internal site name from the controller URL (`/manage/site/<name>`).
        - `type` 'UnifiLocalAdmin', required
        - `username` string, required — Local admin account on the controller.
      - object — HPE Networking Instant On cloud portal account. The endpoint is HPE's cloud, not a host on the network — bind this to the Instant On switch it reports on. Requires an account with **MFA disabled**; use a dedicated site account with the read-only Viewer role.
        - `password` union, required — Secret value that can be either inline content or a file path on the daemon host.
          - object
            - `mode` 'Inline', required
            - `value` string, required — The secret itself. Write-only — reads return a redacted placeholder.
          - object
            - `mode` 'FilePath', required
            - `path` string, required — Path to a file on the daemon host holding the secret.
        - `site` string, nullable — Restrict the fetch to one site by name. Blank ⇒ every site the account can see.
        - `type` 'InstantOnAccount', required
        - `username` string, required — Portal account email address.
    - `host_assignments` CredentialHostAssignment[], required — Hosts this credential is assigned to (PerHost scope), with optional IP scoping. Hydrated from the `host_credentials` junction table.
      - `host_id` string, uuid, required — The host this entity belongs to.
      - `ip_address_ids` string[], nullable, required — IP address IDs to limit this credential to on the host. None = all host ip_addresses.
    - `name` string, required — Human-facing name for this credential.
    - `organization_id` string, uuid, required — The organization that owns this record.
    - `tags` string[], required — Tags assigned to this entity.
    - `created_at` string, date-time, required — When this record was first created.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `updated_at` string, date-time, required — When this record was last modified.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` PaginatedApiMeta, required — API metadata for paginated list responses (pagination is always present)
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `pagination` PaginationMeta, required — Pagination metadata returned with paginated responses.
      - `group_counts` GroupCount[], nullable — Size of every group, in the same order the rows are grouped, when the request specified a `group_by`. Lets a paginated client show a group's true size instead of the slice of it that happens to be on this page. Absent when the list isn't grouped.
        - `count` integer, required — How many rows fall in this group in total, not just on this page.
        - `value` string, nullable — The group's value, rendered as text. `null` for rows whose group key is NULL (the "ungrouped" bucket).
      - `has_more` boolean, required — Whether there are more items after this page
      - `limit` integer, required — Maximum items per page (as requested)
      - `offset` integer, required — Number of items skipped
      - `total_count` integer, required — Total number of items matching the filter (ignoring pagination)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

---

[API](https://skmtc.net/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.net/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/2df1fc47dfa7/schema)