# Swaggerhub

Accelerating API delivery and quality through standards and collaboration, built on OpenAPI

- **Category:** developer tools
- **Auth:** API_KEY
- **Tools:** 49
- **Triggers:** 0
- **Slug:** `SWAGGERHUB`
- **Version:** 00000000_00

## Tools

### Add Access Control for Teams

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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 version with GET /apis/{owner}/{api}/{version}.

### Get API Versions

**Slug:** `SWAGGERHUB_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 authenticated user does not have access to a private API.

### Get Consumer Products

**Slug:** `SWAGGERHUB_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 require authentication.

### Get API Definition

**Slug:** `SWAGGERHUB_GET_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 Domain Default Version

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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

**Slug:** `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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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 authentication. Returns domain information in APIs.json format including referencing APIs.

### Get Domain YAML Definition

**Slug:** `SWAGGERHUB_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 JSON API Definition

**Slug:** `SWAGGERHUB_GET_JSON_API_DEFINITION`

Tool to download OpenAPI definition as a JSON file from SwaggerHub Portal API. Use when you need to retrieve the API specification in JSON format.

### Get JSON Definition

**Slug:** `SWAGGERHUB_GET_JSON_DEFINITION`

Tool to get the OpenAPI definition for a specified API version in JSON format. Use when you need to retrieve the complete API specification from SwaggerHub. Returns the OpenAPI/Swagger definition which includes paths, operations, schemas, and other API metadata.

### Get lifecycle settings

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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 organization owner.

### Get User Organizations

**Slug:** `SWAGGERHUB_GET_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 paginated using page and pageSize parameters.

### Get Organization Projects V2

**Slug:** `SWAGGERHUB_GET_ORG_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 are not available in the organization's plan, or 404 if the organization is not found.

### Get Owner APIs

**Slug:** `SWAGGERHUB_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 sorted by various criteria.

### Get owner domains

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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 results with details about each request including user information, product, status, and timestamps.

### Get Portal Attachment

**Slug:** `SWAGGERHUB_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 for branding attachments or public product attachments.

### Get Portal Product

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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 Portals

**Slug:** `SWAGGERHUB_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 Portal Templates

**Slug:** `SWAGGERHUB_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 API Version Private Settings

**Slug:** `SWAGGERHUB_GET_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.

### List Resource Types and Roles

**Slug:** `SWAGGERHUB_GET_RESOURCE_TYPES`

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, teams, and organizations.

### Get Templates

**Slug:** `SWAGGERHUB_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 Roles

**Slug:** `SWAGGERHUB_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 API Definition

**Slug:** `SWAGGERHUB_GET_YAML_API_DEFINITION`

Tool to download OpenAPI definition as a YAML file from SwaggerHub Portal API. Use when you need to retrieve the API specification in YAML format.

### Get YAML Definition

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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.

### Remove Access Control for Teams

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_REMOVE_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

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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, owner, and free text search with pagination and sorting.

### Search Domains

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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, but authentication provides access to private products within the API key's access boundary.

### Update Access Control for Teams

**Slug:** `SWAGGERHUB_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

**Slug:** `SWAGGERHUB_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 products.

### Update Access Control for Teams

**Slug:** `SWAGGERHUB_UPDATE_ACCESS_CONTROL_TEAMS`

Tool to update access control for teams on a SwaggerHub resource. Use when you need to grant or modify team permissions for an API, domain, project, or portal product.

### Update Access Control Users

**Slug:** `SWAGGERHUB_UPDATE_ACCESS_CONTROL_USERS`

Tool to update access control roles for users on a SwaggerHub resource. Use when you need to change user permissions (CONSUMER, DESIGNER, or OWNER) for APIs, domains, projects, organizations, teams, or portal products.

### Update Portal

**Slug:** `SWAGGERHUB_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.
