SCscanopy
Credentials

Export credentials to CSV

Changed on

Export all credentials matching the filter criteria to CSV format. Ignores pagination parameters (limit/offset) and exports all matching records.

get/api/v1/credentials/export/csv

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/credentials/export/csv
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Query parameters

typeCredentialTypeDiscriminants[] nullable

Filter by credential type (e.g. SnmpCommunity, DockerProxy). Repeat for several.

integrationsCredentialIntegration[] nullable

Only credentials of one of these integrations. Repeat for several.

betaboolean[] nullable

Only credentials whose type is in beta (true), stable (false), or both (repeat it). Sent empty, matches none.

unofficial_apiboolean[] nullable

Only credentials whose type reads an unpublished API (true), a published one (false), or both (repeat it). Sent empty, matches none.

targetsTarget[] nullable

Only credentials whose type can be applied to one of these targets. Repeat for several.

daemon_osOsFamily[] nullable

Only file and socket credentials for one of these daemon OS families. Repeat for several.

site_idsstring[] nullable

Only credentials assigned to one of these sites. Repeat for several.

tag_idsstring[] nullable

Filter by tag IDs (returns credentials that have ANY of the specified tags)

tag_setsstring[] nullable

Tag sets the credential must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.

searchstring nullable

Free-text search. Case-insensitive substring match against the name and description.

group_by'created_at' | 'name' | 'updated_at' | 'credential_type' | 'integration' | 'beta' | 'unofficial_api' | 'daemon_os'

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by'created_at' | 'name' | 'updated_at' | 'credential_type' | 'integration' | 'beta' | 'unofficial_api' | 'daemon_os'

Secondary ordering field (sorting within groups or standalone sort).

group_by_tag_groupstring uuid nullable

Group by the tag each row holds from this tag group. Takes the place of group_by.

order_by_tag_groupstring uuid nullable

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

Response

CSV file containing Credentials

Changes

  • f6cd10b4c7acRevision changes
    • breaking

      removed the enum value SnmpV1 from the property items/ of the query request parameter type

    • breaking

      removed the enum value SnmpV2c from the property items/ of the query request parameter type

    • info

      added the enum value SnmpCommunity to the property items/ of the query request parameter type

  • c9f50be8bc26Revision changes
    • breaking

      for the query request parameter type, the type changed from no type to array null

    • info

      added the new optional query request parameter beta

    • info

      added the new optional query request parameter daemon_os

    • info

      added the new optional query request parameter group_by_tag_group

    • info

      added the new optional query request parameter integrations

    • info

      added the new optional query request parameter order_by_tag_group

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter site_ids

    • info

      added the new optional query request parameter tag_ids

    • info

      added the new optional query request parameter tag_sets

    • info

      added the new optional query request parameter targets

    • info

      added the new optional query request parameter unofficial_api

    • info

      added the enum value beta to the property oneOf[CredentialOrderField]/ of the query request parameter group_by

    • info

      added the enum value beta to the property oneOf[CredentialOrderField]/ of the query request parameter order_by

    • info

      added the enum value credential_type to the property oneOf[CredentialOrderField]/ of the query request parameter group_by

    • info

      added the enum value credential_type to the property oneOf[CredentialOrderField]/ of the query request parameter order_by

    • info

      added the enum value daemon_os to the property oneOf[CredentialOrderField]/ of the query request parameter group_by

    • info

      added the enum value daemon_os to the property oneOf[CredentialOrderField]/ of the query request parameter order_by

    • info

      added the enum value integration to the property oneOf[CredentialOrderField]/ of the query request parameter group_by

    • info

      added the enum value integration to the property oneOf[CredentialOrderField]/ of the query request parameter order_by

    • info

      added the enum value unofficial_api to the property oneOf[CredentialOrderField]/ of the query request parameter group_by

    • info

      added the enum value unofficial_api to the property oneOf[CredentialOrderField]/ of the query request parameter order_by