ToolService
Tool Set Secrets

List tool set secrets

Changed on

Lists all secrets scoped to the tool set

get/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/secrets

Request

  • Base URL
    https://api.cadenya.com
  • URL
    https://api.cadenya.com/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/secrets
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

The workspace that owns the tool set.

toolSetIdstring required
Example:toolset_01HXKD2E5NQM3T9AYWCFNRMN74

The tool set whose secrets will be listed. Accepts the canonical ts_… form or the external_id:<value> form.

Query parameters

limitinteger

Maximum number of results to return

cursorstring

Pagination cursor from previous response

prefixstring

Filter expression (query param: prefix)

querystring

Free-form search query

sortOrderstring

Sort order for results (asc or desc by creation time)

includeInfoboolean

When set to true you may use more of your alloted API rate-limit

Response

OK

Example response

{
  "items": [
    {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      },
      "info": {
        "createdBy": {
          "metadata": {
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
          }
        }
      }
    }
  ]
}

Changes

  • a99a473ee3adRevision changes
    • warning

      removed the optional property / from the response with the status

  • 06e0e37c1499Revision changes
    • warning

      deleted the query request parameter bundleKey

    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property ///////// to the response with the status