Give Feedback

pydo.tools.list_search_providers()

Generated on 1 Oct 2026 from pydo version v0.43.0

Copy page as Markdown View page as Markdown

Usage

client.tools.list_search_providers(
    query=None,
    page_size=20,
    page_token=None,
)

Returns JSONRaises HttpResponseError

Description

Returns the providers of GET /v2/action-gateway/tools/providers whose name, display name, or description contains query, case-insensitively, sorted by name. Cursor-paged with page_size and page_token; no total is reported.

Parameters

query string optional

Matched case-insensitively as a substring of name, display_name, or description. It does not match the titles of the tools a provider owns: "providers owning a tool that matches" is a tool search grouped by the provider field of each result.

page_size integer optional

Page size, 1 to 100. Defaults to 20 when omitted or 0; other values are rejected with 400.

Min: 1

Max: 100

Default: 20

page_token string optional

next_page_token from the previous response. Valid only with the same query; otherwise the request is rejected with 400.

Response Example

Show Response Example

{
  "providers": [
    {
      "name": "jira",
      "display_name": "Jira",
      "description": "Jira issue tracking tools.",
      "auth_type": "oauth",
      "scopes": [
        "write:jira-work"
      ],
      "connection_parameters": [
        {
          "key": "site_url",
          "label": "Jira site URL",
          "description": "The HTTPS origin of the Jira Cloud site to use.",
          "input_kind": "https_origin",
          "required": true,
          "normalization": "https_origin",
          "allowed_values": [],
          "allowed_host_suffixes": [
            "atlassian.net"
          ],
          "max_length": 255,
          "pattern": ""
        }
      ],
      "auth_types": [
        "oauth"
      ],
      "credential_parameters": [],
      "oauth_client_setup_url": "https://developer.atlassian.com/console/myapps/",
      "oauth_redirect_url": "https://cloud.digitalocean.com/api/v1/security/connectlinks/callback"
    }
  ],
  "next_page_token": ""
}

More Information

See /v2/action-gateway/tools/providers/search in the API reference for additional detail on responses, headers, parameters, and more.