WorkspaceSecretService
Workspace Secrets

List workspace secrets

Lists all workspace secrets in the workspace

get/v1/workspaces/{workspaceId}/workspace_secrets

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

The workspace whose secrets will be listed.

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

labelsstring

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

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 5 of the 57 revisions of this API.43

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

      response-optional-property-removed

    • added the new optional query request parameter labels

      new-optional-request-parameter

    • 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[WorkspaceSecretInfo]/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

    • added the optional property items/items/metadata/updatedAt to the response with the 200 status

      response-optional-property-added

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

    • added the new PROFILE_TYPE_UNSPECIFIED enum value to the items/items/info/allOf[WorkspaceSecretInfo]/createdBy/spec/type response property for the response status 200

      response-property-enum-value-added