- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 44
- Triggers: 0
- Slug:
SWAGGERHUB - Version: 20261101_00
Tools
Add Access Control for Teams
Add Access Control for Teams
SWAGGERHUB_ADD_ACCESS_CONTROL_FOR_TEAMSTool 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.Input Parameters
Output
Add Access Control for Users
Add Access Control for Users
SWAGGERHUB_ADD_ACCESS_CONTROL_FOR_USERSTool 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.Input Parameters
Output
Delete Table of Contents Entry
Delete Table of Contents Entry
SWAGGERHUB_DELETE_TABLE_OF_CONTENTS_ENTRYDelete a SwaggerHub portal table of contents entry by ID, optionally including nested entries. A 404 response is reported as success, so success does not confirm that an entry was deleted.Input Parameters
portal-subdomain:product-slug:section-slug:table-of-contents-slugOutput
Get Access Control Users
Get Access Control Users
SWAGGERHUB_GET_ACCESS_CONTROL_USERSTool 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.Input Parameters
Output
Get API Default Version
Get API Default Version
SWAGGERHUB_GET_API_DEFAULT_VERSIONTool 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 version with GET /apis/{owner}/{api}/{version}.Input Parameters
Output
Get API Versions
Get API Versions
SWAGGERHUB_GET_API_VERSIONSTool 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 authenticated user does not have access to a private API.Input Parameters
Output
Get Consumer Products
Get Consumer Products
SWAGGERHUB_GET_CONSUMER_PRODUCTSList products visible to a consumer in a SwaggerHub portal, with an optional access filter and pagination. An upstream 404 is returned as an empty product list.Input Parameters
Output
Get API Definition
Get API Definition
SWAGGERHUB_GET_DEFINITIONRetrieve the definition of a specified SwaggerHub API version, including its endpoints, schemas, and documentation. Optionally resolve external references or flatten inline schemas into models; AsyncAPI definitions cannot be flattened.Input Parameters
Output
Get Domain Default Version
Get Domain Default Version
Get domain definition
Get domain definition
Get Domain JSON Definition
Get Domain JSON Definition
Get Domain Lifecycle Settings
Get Domain Lifecycle Settings
Get Domain Private Settings
Get Domain Private Settings
Get Domain Versions
Get Domain Versions
SWAGGERHUB_GET_DOMAIN_VERSIONSTool 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 authentication. Returns domain information in APIs.json format including referencing APIs.Input Parameters
Output
Get Domain YAML Definition
Get Domain YAML Definition
Get lifecycle settings
Get lifecycle settings
Get Organization Members
Get Organization Members
SWAGGERHUB_GET_ORGANIZATION_MEMBERSTool 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 organization owner.Input Parameters
Output
Get User Organizations
Get User Organizations
SWAGGERHUB_GET_ORGANIZATIONSTool 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 paginated using page and pageSize parameters.Input Parameters
Output
Get Organization Projects V2
Get Organization Projects V2
SWAGGERHUB_GET_ORG_PROJECTS_V2Tool 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 are not available in the organization’s plan, or 404 if the organization is not found.Input Parameters
Output
Get Owner APIs
Get Owner APIs
SWAGGERHUB_GET_OWNER_APISTool 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 sorted by various criteria.Input Parameters
Output
Get owner domains
Get owner domains
SWAGGERHUB_GET_OWNER_DOMAINSTool to retrieve domains owned by a specific SwaggerHub user or organization. Use when you need to list all domains associated with an owner.Input Parameters
Output
Get Portal
Get Portal
Get Portal Access Requests
Get Portal Access Requests
SWAGGERHUB_GET_PORTAL_ACCESS_REQUESTSRetrieve paginated access requests for a SwaggerHub portal, optionally filtered by status or search query, with user, product, status, and timestamp details. A 403 response is returned as an empty result, so an empty result does not establish that no requests exist.Input Parameters
Output
Get Portal Attachment
Get Portal Attachment
SWAGGERHUB_GET_PORTAL_ATTACHMENTTool 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 for branding attachments or public product attachments.Input Parameters
Output
Get Portal Product
Get Portal Product
Get Portal Products
Get Portal Products
Get Portals
Get Portals
Get Portal Templates
Get Portal Templates
Get API Version Private Settings
Get API Version Private Settings
List Resource Types and Roles
List Resource Types and Roles
SWAGGERHUB_GET_RESOURCE_TYPESTool 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, teams, and organizations.Input Parameters
Output
Get Templates
Get Templates
SWAGGERHUB_GET_TEMPLATESTool 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.Input Parameters
Output
Get User Roles
Get User Roles
Get YAML Definition
Get YAML Definition
SWAGGERHUB_GET_YAML_DEFINITIONTool 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.Input Parameters
Output
List Attachments
List Attachments
SWAGGERHUB_LIST_ATTACHMENTSTool 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.Input Parameters
Output
Remove Access Control for Teams
Remove Access Control for Teams
SWAGGERHUB_REMOVE_ACCESS_CONTROL_FOR_TEAMSTool 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.Input Parameters
Output
Remove Access Control For Users
Remove Access Control For Users
SWAGGERHUB_REMOVE_ACCESS_CONTROL_FOR_USERSTool 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.Input Parameters
Output
Remove Organization Members
Remove Organization Members
Search APIs
Search APIs
Search APIs and Domains
Search APIs and Domains
SWAGGERHUB_SEARCH_APIS_AND_DOMAINSTool 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, owner, and free text search with pagination and sorting.Input Parameters
Output
Search Domains
Search Domains
Search Published Portal
Search Published Portal
SWAGGERHUB_SEARCH_PUBLISHED_PORTALSearch published content in a specific SwaggerHub portal for APIs, operations, schemas, or documents. The tool uses a SwaggerHub API key connection.Input Parameters
Output
Update Access Control for Teams
Update Access Control for Teams
SWAGGERHUB_UPDATE_ACCESS_CONTROL_FOR_TEAMSTool 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.Input Parameters
Output
Update Access Control for Users
Update Access Control for Users
SWAGGERHUB_UPDATE_ACCESS_CONTROL_FOR_USERSTool 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 products.Input Parameters
Output
Update Portal
Update Portal
SWAGGERHUB_UPDATE_PORTALTool to update specific portal information in SwaggerHub. Use when you need to modify portal settings such as name, branding, subdomain, or other configuration options.