ToolService
Tool Set Secrets

List tool set secrets

Lists all secrets scoped to the tool set

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

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

Changed in 3 of the 57 revisions of this API.32

    • removed the optional property pagination/total from the response with the 200 status

      response-optional-property-removed

    • deleted the query request parameter bundleKey

      request-parameter-removed

    • removed the optional property items/items/metadata/bundleKey from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/items/info/allOf[ToolSetSecretInfo]/createdBy/metadata/createdAt to the response with the 200 status

      response-optional-property-added

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added