Skip to main content
Swaggerhub logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 44
  • Triggers: 0
  • Slug: SWAGGERHUB
  • Version: 20261101_00

Tools

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

string
required
Organization identifier
array
required
List of teams with their assigned roles to add access control
string
required
Name of the resource to add team access for
string ("API" | "DOMAIN" | "PROJECT" | "PORTAL_PRODUCT")
required
Type of the resource (API, DOMAIN, PROJECT, or PORTAL_PRODUCT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Organization identifier (owner name)
array
required
List of users with their assigned roles to add access control. Each user must have an email and role specified.
string
required
Name of the organizational resource to add user access for
string ("API" | "DOMAIN" | "PROJECT" | "ORGANIZATION" | "TEAM" | "PORTAL_PRODUCT")
required
Type of the organizational resource (API, DOMAIN, PROJECT, ORGANIZATION, TEAM, or PORTAL_PRODUCT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Flag to include all the nested tables of contents
string
required
The table of contents UUID, or identifier in the format portal-subdomain:product-slug:section-slug:table-of-contents-slug

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
0-based index of the page to return for pagination.
string
required
Organization identifier to query access control users for.
integer
Number of results per page to return, must be between 1 and 100.
string
required
Name of the resource to query access control users for.
string ("API" | "DOMAIN" | "PROJECT" | "ORGANIZATION" | "TEAM" | "PORTAL_PRODUCT")
required
Type of the resource to query access control users for.
string ("all" | "active" | "invited")
Filter users by invitation status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
API name (case-sensitive). This is the unique identifier of the API within the owner’s account.
string
required
API owner (organization or user, case-sensitive). This is the account that owns the API in SwaggerHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
API name (case-sensitive). This is the name of the API for which to retrieve versions.
string
required
API owner (organization or user, case-sensitive). This is the SwaggerHub organization or user name that owns the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The 1-based index of the page to return. If not specified, the first page is returned.
integer
The number of results to return per page.
array
Embed related resources in the response.
string
required
Portal UUID or subdomain.
boolean
Filter based on whether you are allowed to access this product or not. If not specified, the results include both accessible and inaccessible products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
API name (case-sensitive). The name of the API as it appears in SwaggerHub.
string
required
API owner (organization or user, case-sensitive). This is the SwaggerHub username or organization name that owns the API.
boolean
If set to true, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. Default is false.
string
required
Version identifier. The specific version of the API definition to retrieve.
boolean
Set to true to get the resolved version of the API definition. The content of all external $refs will be included in the resulting file. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_DOMAIN_DEFAULT_VERSIONTool 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.

Input Parameters

string
required
Domain owner (organization or user, case-sensitive).
string
required
Domain name (case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_DOMAIN_DEFINITIONTool to retrieve the OpenAPI definition of a specified domain version from SwaggerHub. Use when you need to access reusable domain components, schemas, or parameters.

Input Parameters

string
required
Domain owner (organization or user, case-sensitive).
string
required
Domain name (case-sensitive).
string
required
Version identifier of the domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_DOMAIN_JSON_DEFINITIONTool 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.

Input Parameters

string
required
Domain owner (organization or user, case-sensitive)
string
required
Domain name (case-sensitive)
string
required
Version identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_DOMAIN_LIFECYCLE_SETTINGSTool 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.

Input Parameters

string
required
Domain owner (organization or user, case-sensitive)
string
required
Domain name (case-sensitive)
string
required
Version identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_DOMAIN_PRIVATE_SETTINGSTool 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.

Input Parameters

string
required
Domain owner (organization or user, case-sensitive).
string
required
Domain name (case-sensitive).
string
required
Version identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Domain owner (organization or user, case-sensitive). This is the account name that owns the domain in SwaggerHub.
string
required
Domain name (case-sensitive). This is the name of the domain definition in SwaggerHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_DOMAIN_YAML_DEFINITIONTool 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.

Input Parameters

string
required
Domain owner (organization or user, case-sensitive)
string
required
Domain name (case-sensitive)
string
required
Version identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_LIFECYCLE_SETTINGSTool 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.

Input Parameters

string
required
API name (case-sensitive)
string
required
API owner (organization or user, case-sensitive)
string
required
Version identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search query to filter members by first name, last name, or email address. Use this to narrow down the member list.
integer
0-based index of the page to return. Use with pageSize to navigate through results.
string ("ASC" | "DESC")
Sort order for results.
string
required
Organization identifier (owner name). This is the organization name in SwaggerHub.
string ("NAME" | "EMAIL" | "START_TIME")
Sort criteria for organization members.
integer
Number of results per page to return. Default is 50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search organizations by partial or full name (case-insensitive). Use to filter results by organization name.
integer
Page number to return (zero-indexed). Use for pagination through results.
string ("ASC" | "DESC")
Enum for sort order.
string ("NAME" | "EMAIL")
Enum for organization sorting criteria.
integer
Number of results per page. Must be between 0 and 100. Use for pagination through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page to return (zero-indexed). Use for pagination through results.
integer
Number of results per page. Must be between 1 and 100.
string ("ASC" | "DESC")
Sort order for the result set.
string
required
Organization name (case-sensitive). This is the organization identifier in SwaggerHub.
boolean
Return the project information excluding APIs and domains. Set to true to get only project names and descriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to return (zero-indexed). Use for pagination through results.
string ("NAME" | "UPDATED" | "CREATED" | "OWNER" | "BEST_MATCH" | "TITLE")
Sort criteria for the result set.
integer
Number of results per page. Must be between 1 and 100.
string ("ASC" | "DESC")
Sort order for the result set.
string
required
API owner (organization or user, case-sensitive). This is the username or organization name in SwaggerHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to return (0-indexed). Use this for pagination when the result set is large.
string ("NAME" | "UPDATED" | "CREATED" | "OWNER" | "BEST_MATCH" | "TITLE")
Sort criteria for domain listing.
integer
Number of results per page. Must be between 1 and 100. Controls how many domain entries are returned in a single response.
string ("ASC" | "DESC")
Sort order for domain listing.
string
required
Domain owner (organization or user, case-sensitive). This is the username or organization name that owns the domains you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_PORTALTool to retrieve information about a portal. Use when you need to fetch details about a specific SwaggerHub portal by its UUID or subdomain.

Input Parameters

array
Embed related resources in the response.
string
required
Portal UUID or subdomain

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search query to filter access requests by user name, email, or other text fields.
integer
The 1-based index of the page to return. If not specified, the first page is returned.
integer
The number of results to return per page. Maximum value depends on API limits.
array
Filter results by status. Returns only access requests matching one of the specified statuses.
string
required
Portal UUID or subdomain. The unique identifier of the portal for which to retrieve access requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Attachment UUID identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_PORTAL_PRODUCTRetrieve information about a specific SwaggerHub portal product using its UUID or portal-subdomain:product-slug identifier. Optionally embed related resources in the response.

Input Parameters

array
Embed related resources in the response.
string
required
Product UUID, or identifier in the format portal-subdomain:product-slug

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_PORTAL_PRODUCTSTool 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.

Input Parameters

string
Filter by the product’s name using case-insensitive exact matching.
integer
The 1-based index of the page to return. Defaults to 1 if not specified.
integer
The number of results to return per page. Defaults to 1000 if not specified.
string
Filter by the product’s slug using case-insensitive exact matching.
array
Embed related resources in the response.
string
required
Portal UUID or subdomain to identify the portal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_PORTALSTool to search for available portals. Returns portals where you have a designer role, either at the product level or organization level.

Input Parameters

integer
The 1-based index of the page to return. If not specified, the first page is returned.
integer
The number of results to return per page.
array
Embed related resources in the response. Specify which resources to include.
string
Filter results by a portal’s subdomain. The filter applies case-insensitive exact matching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_PORTAL_TEMPLATESTool 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.

Input Parameters

string
Filter by the template’s name. The filter applied uses case-insensitive exact matching.
integer
The 1-based index of the page to return. If not specified, the first page is returned.
integer
The number of results to return per page.
array
Embed related resources in the response.
string
required
Portal UUID or subdomain identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_PRIVATE_SETTINGSTool 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.

Input Parameters

string
required
API name (case-sensitive)
string
required
API owner (organization or user, case-sensitive)
string
required
Version identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The organization identifier (UUID format). This is the unique identifier for the organization whose resource types you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Owner name to filter templates by (case-sensitive). If not specified, returns all available templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_GET_USER_ROLESRetrieve a page of roles assigned to a user across resources in a SwaggerHub organization, including APIs, teams, domains, and other resources.

Input Parameters

integer
Page number for pagination (zero-indexed).
string
required
The user’s email address to retrieve roles for.
string
required
The organization owner ID (UUID format).
integer
Number of results per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
API name (case-sensitive). The name of the API as it appears in SwaggerHub.
string
required
API owner (organization or user, case-sensitive). This is the SwaggerHub username or organization name that owns the API.
boolean
If set to true, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. Default is false.
string
required
Version identifier. The specific version of the API definition to retrieve.
boolean
Set to true to get the resolved version of the API definition. The content of all external $refs will be included in the resulting file. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Portal identifier (mutually exclusive with productId). Retrieve attachments for this specific portal.
string
Product identifier (mutually exclusive with portalId). Retrieve attachments for this specific product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Organization identifier
array
required
Team names to remove access control for
string
required
Name of organizational resource
string ("API" | "DOMAIN" | "PROJECT" | "PORTAL_PRODUCT")
required
Organizational resource type (API, DOMAIN, PROJECT, or PORTAL_PRODUCT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Organization identifier
array
required
List of members’ email addresses to remove access control for
string
required
Name of organizational resource
string ("API" | "DOMAIN" | "PROJECT" | "ORGANIZATION" | "TEAM" | "PORTAL_PRODUCT")
required
Organizational resource type (API, DOMAIN, PROJECT, ORGANIZATION, TEAM, or PORTAL_PRODUCT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_REMOVE_MEMBERSTool to remove members from a SwaggerHub organization. Use when you need to revoke membership for one or more users by their email addresses.

Input Parameters

array
required
Email addresses of the users to remove from the organization. Multiple emails can be provided.
string
required
Organization identifier (owner name).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_SEARCH_APISSearch SwaggerHub APIs by free text and published state, with pagination and sorting.

Input Parameters

integer
Page number to return (0-indexed). Default is 0.
string ("NAME" | "UPDATED" | "CREATED" | "OWNER" | "BEST_MATCH" | "TITLE")
Enum for sort criteria.
integer
Number of results per page (1-100). Default is 10.
string ("ASC" | "DESC")
Enum for sort order.
string
Free text query to match against API names and descriptions.
string ("ALL" | "PUBLISHED" | "UNPUBLISHED")
Enum for API published state filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number to return (0-indexed). Default is 0.
string ("NAME" | "UPDATED" | "CREATED" | "OWNER" | "BEST_MATCH" | "TITLE")
Enum for sort criteria.
integer
Number of results per page (1-100). Default is 10.
string ("ASC" | "DESC")
Enum for sort order.
string
API or domain owner. Can be username or organization name. Case-sensitive.
string
Free text query to match against names and descriptions.
string ("ALL" | "PUBLISHED" | "UNPUBLISHED")
Enum for published state filter.
string ("API" | "DOMAIN" | "TEMPLATE" | "ANY")
Enum for spec type filter.
string ("PUBLIC" | "PRIVATE" | "ANY")
Enum for visibility filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SWAGGERHUB_SEARCH_DOMAINSSearch SwaggerHub domains by text or published state, with pagination and sorting.

Input Parameters

integer
Page number to return (0-indexed). Default is 0.
string ("NAME" | "UPDATED" | "CREATED" | "OWNER" | "BEST_MATCH" | "TITLE")
Enum for sort criteria.
integer
Number of results per page (1-100). Default is 10.
string ("ASC" | "DESC")
Enum for sort order.
string
Free text query to match against domain names and descriptions.
string ("ALL" | "PUBLISHED" | "UNPUBLISHED")
Enum for domain published state filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Search query string to match against portal content.
integer
The 1-based index of the page to return. If not specified, the first page is returned.
integer
The number of results to return per page. Default is 50 if not specified.
string
required
Portal UUID or subdomain to search within. A 404 indicates the portal does not exist or is configured to be offline.
array
Filter results by one or more result types. If not specified, all types are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Organization identifier
array
required
List of teams with their assigned roles to update access control
string
required
Name of the resource to update team access for
string ("API" | "DOMAIN" | "PROJECT" | "PORTAL_PRODUCT")
required
Type of the resource (API, DOMAIN, PROJECT, or PORTAL_PRODUCT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Organization identifier
array
required
List of users with their assigned roles to update access control
string
required
Name of the organizational resource to update user access for
string ("API" | "DOMAIN" | "PROJECT" | "ORGANIZATION" | "TEAM" | "PORTAL_PRODUCT")
required
Type of the organizational resource (API, DOMAIN, PROJECT, ORGANIZATION, TEAM, or PORTAL_PRODUCT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
The name for this portal
Footer configuration for the portal.
string
The Google Tag Manager key for this portal. Set to null to remove.
boolean
If set to true, the portal is not visible to customers.
string ("browser" | "proxy")
Routing strategy options.
object
Branding configuration for the portal.
string
required
Portal UUID or subdomain
string
Subdomain for this portal. Must be unique.
object
Landing page configuration for the portal.
string
Custom domain for this portal. Must be unique. If the value is explicitly set to null, the custom domain will be removed.
string ("SWAGGER_UI" | "ELEMENTS" | "TOGGLE")
OpenAPI renderer options.
string ("BOTH" | "HTML" | "MARKDOWN")
Page content format options.
boolean
Indicates if credentials are enabled for the portal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not