Team
Shared credential for production and unattended runs.
Connect Swaggerhub with Hookshot™ and your stack
Accelerating API delivery and quality through standards and collaboration, built on OpenAPI
Tools and triggers
What Agents can do in Swaggerhub
Available tools and events after Swaggerhub is connected.
-
Add Access Control for Teams
Tool to assign access control roles to teams on a SwaggerHub resource. Use when you need to grant team permissions (OWNER, DESIGNER, CONSUMER) for APIs, domains, projects, or portal products.
-
Add Access Control for Users
Tool to assign access control roles to users on a SwaggerHub resource. Use when you need to grant user permissions (owner, designer, consumer) for APIs, domains, projects, organizations, teams, or portal products.
-
Delete Table of Contents Entry
Tool to delete a table of contents entry from SwaggerHub portal. Use when you need to remove a table of contents entry by its ID. Optionally supports recursive deletion of nested entries.
-
Get Access Control Users
Tool to retrieve the list of users assigned access control on a SwaggerHub resource. Use when you need to check who has access to an API, domain, project, organization, team, or portal product.
-
Get API Default Version
Tool to get the default version identifier of a SwaggerHub API. Use when you need to know which version is marked as default for an API. This returns only the version identifier; to get the full API definition, use the…
-
Get API Definition
Tool to get the OpenAPI definition of a specified API version from SwaggerHub. Use when you need to retrieve the complete API specification including endpoints, schemas, and documentation for a specific API version.
-
Get API Version Private Settings
Tool to get the visibility (public or private) of an API version. Use when you need to check whether a specific API version is publicly accessible or private.
-
Get API Versions
Tool to retrieve a list of API versions for a specific API in SwaggerHub. Use when you need to get all versions of an API owned by an organization or user. Returns 404 if the specified API is not found or if the…
-
Get Consumer Products
Tool to get a list of products that are visible to the consumer in a SwaggerHub portal. Use when you need to retrieve products from a portal, including both accessible and inaccessible products. This endpoint does not…
-
Get Domain Default Version
Tool to retrieve the default version identifier of a SwaggerHub domain. Use when you need to know which version is set as default for a domain before fetching its definition.
-
Get Domain Definition
Tool to retrieve the OpenAPI definition of a specified domain version from SwaggerHub. Use when you need to access reusable domain components, schemas, or parameters.
-
Get Domain JSON Definition
Tool to retrieve the OpenAPI definition for a specified domain version in JSON format. Use when you need to access the domain definition document from SwaggerHub.
-
Get Domain Lifecycle Settings
Tool to get the published status for a specific domain and version in SwaggerHub. Use when you need to check if a domain version is published or unpublished.
-
Get Domain Private Settings
Tool to retrieve the visibility (public or private) of a domain version in SwaggerHub. Use when you need to check whether a specific domain version is accessible publicly or restricted to private access.
-
Get Domain Versions
Tool to get a list of domain versions from SwaggerHub. Use when you need to retrieve all versions of a domain definition and see which APIs reference it. The domain must exist and be accessible with the provided…
-
Get Domain YAML Definition
Tool to retrieve the OpenAPI definition for a specified domain version in YAML format from SwaggerHub. Use when you need to fetch domain schemas or API specifications in YAML format.
-
Get Lifecycle Settings
Tool to get the published status for the specified API and version. Use when you need to check if an API version is published or unpublished.
-
Get Organization Members
Tool to retrieve a list of organization members and their roles from SwaggerHub. Use when you need to view member details including email addresses, roles, and last activity. The authenticating user must be the…
-
Get Organization Projects V2
Tool to get all projects of an organization in SwaggerHub. Use when you need to retrieve projects belonging to a specific organization. Projects organize APIs and domains into logical groups. Returns 403 if projects…
-
Get Owner APIs
Tool to get a list of APIs for a specified owner in SwaggerHub. Use when you need to retrieve all APIs belonging to a specific user or organization. Results are returned in APIs.json format and can be paginated and…
-
Get Owner Domains
Tool to retrieve domains owned by a specific SwaggerHub user or organization. Use when you need to list all domains associated with an owner.
-
Get Portal
Tool to retrieve information about a portal. Use when you need to fetch details about a specific SwaggerHub portal by its UUID or subdomain.
-
Get Portal Access Requests
Tool to retrieve access requests for a portal in SwaggerHub. Use when you need to list all users who have requested access to a portal's products, with optional filtering by status or search query. Returns paginated…
-
Get Portal Attachment
Tool to get informational attachment metadata from SwaggerHub Portal. Use when you need to retrieve details about a specific attachment by its UUID. This endpoint supports both authenticated and unauthenticated access…
-
Get Portal Product
Tool to retrieve detailed information about a specific product resource. Use when you need to fetch complete details about a product using its UUID or portal-subdomain:product-slug identifier.
-
Get Portal Products
Tool to get products for a specific portal that match your criteria. Use when you need to retrieve a list of products from a portal, with optional filtering by name or slug and pagination support.
-
Get Portal Templates
Tool to get templates for a specific portal that match your criteria. Use when you need to list or search for templates within a portal by name or other filters. Supports pagination for large result sets.
-
Get Portals
Tool to search for available portals. Returns portals where you have a designer role, either at the product level or organization level.
-
Get Templates
Tool to retrieve a list of templates for an owner in SwaggerHub. Use when you need to get available templates for creating new API definitions or domain models.
-
Get User Organizations
Tool to get organizations for a user. Use when you need to retrieve all organizations that the authenticating user is a member of. Results can be filtered by name using the q parameter, sorted by name or email, and…
-
Get User Roles
Tool to retrieve all roles assigned to a user across organization resources in SwaggerHub. Use when you need to check what permissions a user has across APIs, teams, domains, and other resources in an organization.
-
Get YAML Definition
Tool to get the OpenAPI definition in YAML format for the specified API version from SwaggerHub. Use when you need to retrieve the API specification as YAML text for parsing, storage, or processing.
-
List Attachments
Tool to retrieve all attachments for a portal or product. Use when you need to list attachments associated with either a specific portal or product. Provide either productId or portalId, not both.
-
List Resource Types and Roles
Tool to list available resource types and assignable roles for each in a SwaggerHub organization. Use when you need to understand what roles can be assigned to different resource types like APIs, domains, projects…
-
Remove Access Control for Teams
Tool to remove access control for teams from a SwaggerHub resource. Use when you need to revoke team permissions from an API, domain, project, or portal product.
-
Remove Access Control for Users
Tool to remove access control for users from a SwaggerHub organizational resource. Use when you need to revoke user access to APIs, domains, projects, organizations, teams, or portal products.
-
Remove Organization Members
Tool to remove members from a SwaggerHub organization. Use when you need to revoke membership for one or more users by their email addresses.
-
Search APIs
Tool to search SwaggerHub APIs. Use when you need to find API definitions in SwaggerHub by name, owner, or other criteria. This is a convenience alias for GET /specs?specType=API.
-
Search APIs and Domains
Tool to search SwaggerHub APIs, domains, and templates. Use when you need to retrieve a list of currently defined APIs, domains, and/or templates in APIs.json format. Supports filtering by spec type, visibility, state…
-
Search Domains
Tool to search SwaggerHub domains. Use when you need to find domain definitions in SwaggerHub by name, owner, or other criteria. This is a convenience alias for GET /specs?specType=DOMAIN.
-
Search Published Portal
Tool to search published portal content. Use when you need to search for APIs, operations, schemas, or documents within a specific SwaggerHub portal. This endpoint does not require authentication for public content…
-
Update Access Control for Teams
Tool to update access control roles for teams on a SwaggerHub resource. Use when you need to assign or change team permissions (designer or consumer) for APIs, domains, projects, or portal products.
-
Update Access Control for Users
Tool to update access control roles for users on a SwaggerHub resource. Use when you need to assign or change user permissions (owner, designer, consumer) for APIs, domains, projects, organizations, teams, or portal…
-
Update Portal
Tool to update specific portal information in SwaggerHub. Use when you need to modify portal settings such as name, branding, subdomain, or other configuration options.
Setup
Connect Swaggerhub in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
