Swaggerhub

swaggerhub

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

Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (49)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Access Control for TeamsSWAGGERHUB_ADD_ACCESS_CONTROL_FOR_TEAMSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Organization identifier
teamsobject[]Obligatorio
List of teams with their assigned roles to add access control
resourceNamestringObligatorio
Name of the resource to add team access for
resourceTypestringObligatorioenum
Type of the resource (API, DOMAIN, PROJECT, or PORTAL_PRODUCT)
APIDOMAINPROJECTPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Access Control for UsersSWAGGERHUB_ADD_ACCESS_CONTROL_FOR_USERSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Organization identifier (owner name)
usersobject[]Obligatorio
List of users with their assigned roles to add access control. Each user must have an email and role specified.
resourceNamestringObligatorio
Name of the organizational resource to add user access for
resourceTypestringObligatorioenum
Type of the organizational resource (API, DOMAIN, PROJECT, ORGANIZATION, TEAM, or PORTAL_PRODUCT)
APIDOMAINPROJECTORGANIZATIONTEAMPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Table of Contents EntrySWAGGERHUB_DELETE_TABLE_OF_CONTENTS_ENTRYAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Access Control UsersSWAGGERHUB_GET_ACCESS_CONTROL_USERSAcción

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.

Parámetros de entrada

pageinteger
0-based index of the page to return for pagination.
ownerstringObligatorio
Organization identifier to query access control users for.
pageSizeinteger
Number of results per page to return, must be between 1 and 100.
resourceNamestringObligatorio
Name of the resource to query access control users for.
resourceTypestringObligatorioenum
Type of the resource to query access control users for.
APIDOMAINPROJECTORGANIZATIONTEAMPORTAL_PRODUCT
statusFilterstringenum
Filter users by invitation status.
allactiveinvited

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API Default VersionSWAGGERHUB_GET_API_DEFAULT_VERSIONAcción

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}.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API VersionsSWAGGERHUB_GET_API_VERSIONSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Consumer ProductsSWAGGERHUB_GET_CONSUMER_PRODUCTSAcción

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.

Parámetros de entrada

pageinteger
The 1-based index of the page to return. If not specified, the first page is returned.
sizeinteger
The number of results to return per page.
embedstring[]
Embed related resources in the response.
portalIdstringObligatorio
Portal UUID or subdomain.
canAccessboolean
Filter based on whether you are allowed to access this product or not. If not specified, the results include both accessible and inaccessible products.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API DefinitionSWAGGERHUB_GET_DEFINITIONAcción

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.

Parámetros de entrada

apistringObligatorio
API name (case-sensitive). The name of the API as it appears in SwaggerHub.
ownerstringObligatorio
API owner (organization or user, case-sensitive). This is the SwaggerHub username or organization name that owns the API.
flattenboolean
If set to true, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. Default is false.
versionstringObligatorio
Version identifier. The specific version of the API definition to retrieve.
resolvedboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Domain Default VersionSWAGGERHUB_GET_DOMAIN_DEFAULT_VERSIONAcción

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.

Parámetros de entrada

ownerstringObligatorio
Domain owner (organization or user, case-sensitive).
domainstringObligatorio
Domain name (case-sensitive).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get domain definitionSWAGGERHUB_GET_DOMAIN_DEFINITIONAcción

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.

Parámetros de entrada

ownerstringObligatorio
Domain owner (organization or user, case-sensitive).
domainstringObligatorio
Domain name (case-sensitive).
versionstringObligatorio
Version identifier of the domain.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Domain JSON DefinitionSWAGGERHUB_GET_DOMAIN_JSON_DEFINITIONAcción

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.

Parámetros de entrada

ownerstringObligatorio
Domain owner (organization or user, case-sensitive)
domainstringObligatorio
Domain name (case-sensitive)
versionstringObligatorio
Version identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Domain Lifecycle SettingsSWAGGERHUB_GET_DOMAIN_LIFECYCLE_SETTINGSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Domain owner (organization or user, case-sensitive)
domainstringObligatorio
Domain name (case-sensitive)
versionstringObligatorio
Version identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Domain Private SettingsSWAGGERHUB_GET_DOMAIN_PRIVATE_SETTINGSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Domain owner (organization or user, case-sensitive).
domainstringObligatorio
Domain name (case-sensitive).
versionstringObligatorio
Version identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Domain VersionsSWAGGERHUB_GET_DOMAIN_VERSIONSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Domain YAML DefinitionSWAGGERHUB_GET_DOMAIN_YAML_DEFINITIONAcción

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.

Parámetros de entrada

ownerstringObligatorio
Domain owner (organization or user, case-sensitive)
domainstringObligatorio
Domain name (case-sensitive)
versionstringObligatorio
Version identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get JSON API DefinitionSWAGGERHUB_GET_JSON_API_DEFINITIONAcción

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.

Parámetros de entrada

apistringObligatorio
The API name (e.g., 'swaggerhub-portal-api')
ownerstringObligatorio
The owner of the API (e.g., 'smartbear-public')
versionstringObligatorio
The API version (e.g., '0.8.0-beta')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get JSON DefinitionSWAGGERHUB_GET_JSON_DEFINITIONAcción

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.

Parámetros de entrada

apistringObligatorio
API name (case-sensitive). The name of the API whose definition you want to retrieve.
ownerstringObligatorio
API owner (organization or user, case-sensitive). The owner of the API whose definition you want to retrieve.
flattenboolean
If set to true, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened.
versionstringObligatorio
Version identifier. The specific version of the API definition to retrieve.
resolvedboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get lifecycle settingsSWAGGERHUB_GET_LIFECYCLE_SETTINGSAcción

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.

Parámetros de entrada

apistringObligatorio
API name (case-sensitive)
ownerstringObligatorio
API owner (organization or user, case-sensitive)
versionstringObligatorio
Version identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organization MembersSWAGGERHUB_GET_ORGANIZATION_MEMBERSAcción

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.

Parámetros de entrada

qstring
Search query to filter members by first name, last name, or email address. Use this to narrow down the member list.
pageinteger
0-based index of the page to return. Use with pageSize to navigate through results.
orderstringenum
Sort order for results.
ASCDESC
ownerstringObligatorio
Organization identifier (owner name). This is the organization name in SwaggerHub.
sortBystringenum
Sort criteria for organization members.
NAMEEMAILSTART_TIME
pageSizeinteger
Number of results per page to return. Default is 50.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User OrganizationsSWAGGERHUB_GET_ORGANIZATIONSAcción

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.

Parámetros de entrada

qstring
Search organizations by partial or full name (case-insensitive). Use to filter results by organization name.
pageinteger
Page number to return (zero-indexed). Use for pagination through results.
orderstringenum
Enum for sort order.
ASCDESC
sortBystringenum
Enum for organization sorting criteria.
NAMEEMAIL
pageSizeinteger
Number of results per page. Must be between 0 and 100. Use for pagination through results.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organization Projects V2SWAGGERHUB_GET_ORG_PROJECTS_V2Acción

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.

Parámetros de entrada

pageinteger
Page to return (zero-indexed). Use for pagination through results.
limitinteger
Number of results per page. Must be between 1 and 100.
orderstringenum
Sort order for the result set.
ASCDESC
ownerstringObligatorio
Organization name (case-sensitive). This is the organization identifier in SwaggerHub.
nameOnlyboolean
Return the project information excluding APIs and domains. Set to true to get only project names and descriptions.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Owner APIsSWAGGERHUB_GET_OWNER_APISAcción

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.

Parámetros de entrada

pageinteger
Page number to return (zero-indexed). Use for pagination through results.
sortstringenum
Sort criteria for the result set.
NAMEUPDATEDCREATEDOWNERBEST_MATCHTITLE
limitinteger
Number of results per page. Must be between 1 and 100.
orderstringenum
Sort order for the result set.
ASCDESC
ownerstringObligatorio
API owner (organization or user, case-sensitive). This is the username or organization name in SwaggerHub.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get owner domainsSWAGGERHUB_GET_OWNER_DOMAINSAcción

Tool to retrieve domains owned by a specific SwaggerHub user or organization. Use when you need to list all domains associated with an owner.

Parámetros de entrada

pageinteger
Page number to return (0-indexed). Use this for pagination when the result set is large.
sortstringenum
Sort criteria for domain listing.
NAMEUPDATEDCREATEDOWNERBEST_MATCHTITLE
limitinteger
Number of results per page. Must be between 1 and 100. Controls how many domain entries are returned in a single response.
orderstringenum
Sort order for domain listing.
ASCDESC
ownerstringObligatorio
Domain owner (organization or user, case-sensitive). This is the username or organization name that owns the domains you want to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PortalSWAGGERHUB_GET_PORTALAcción

Tool to retrieve information about a portal. Use when you need to fetch details about a specific SwaggerHub portal by its UUID or subdomain.

Parámetros de entrada

embedstring[]
Embed related resources in the response.
portalIdstringObligatorio
Portal UUID or subdomain

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Portal Access RequestsSWAGGERHUB_GET_PORTAL_ACCESS_REQUESTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Portal AttachmentSWAGGERHUB_GET_PORTAL_ATTACHMENTAcción

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.

Parámetros de entrada

attachment_idstringObligatorio
Attachment UUID identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Portal ProductSWAGGERHUB_GET_PORTAL_PRODUCTAcción

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.

Parámetros de entrada

embedstring[]
Embed related resources in the response.
productIdstringObligatorio
Product UUID, or identifier in the format `portal-subdomain:product-slug`

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Portal ProductsSWAGGERHUB_GET_PORTAL_PRODUCTSAcción

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.

Parámetros de entrada

namestring
Filter by the product's name using case-insensitive exact matching.
pageinteger
The 1-based index of the page to return. Defaults to 1 if not specified.
sizeinteger
The number of results to return per page. Defaults to 1000 if not specified.
slugstring
Filter by the product's slug using case-insensitive exact matching.
embedstring[]
Embed related resources in the response.
portalIdstringObligatorio
Portal UUID or subdomain to identify the portal.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PortalsSWAGGERHUB_GET_PORTALSAcción

Tool to search for available portals. Returns portals where you have a designer role, either at the product level or organization level.

Parámetros de entrada

pageinteger
The 1-based index of the page to return. If not specified, the first page is returned.
sizeinteger
The number of results to return per page.
embedstring[]
Embed related resources in the response. Specify which resources to include.
subdomainstring
Filter results by a portal's subdomain. The filter applies case-insensitive exact matching.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Portal TemplatesSWAGGERHUB_GET_PORTAL_TEMPLATESAcción

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.

Parámetros de entrada

namestring
Filter by the template's name. The filter applied uses case-insensitive exact matching.
pageinteger
The 1-based index of the page to return. If not specified, the first page is returned.
sizeinteger
The number of results to return per page.
embedstring[]
Embed related resources in the response.
portalIdstringObligatorio
Portal UUID or subdomain identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API Version Private SettingsSWAGGERHUB_GET_PRIVATE_SETTINGSAcción

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.

Parámetros de entrada

apistringObligatorio
API name (case-sensitive)
ownerstringObligatorio
API owner (organization or user, case-sensitive)
versionstringObligatorio
Version identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Resource Types and RolesSWAGGERHUB_GET_RESOURCE_TYPESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TemplatesSWAGGERHUB_GET_TEMPLATESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User RolesSWAGGERHUB_GET_USER_ROLESAcción

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.

Parámetros de entrada

pageinteger
Page number for pagination (zero-indexed).
userstringObligatorio
The user's email address to retrieve roles for.
owner_idstringObligatorio
The organization owner ID (UUID format).
pageSizeinteger
Number of results per page.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get YAML API DefinitionSWAGGERHUB_GET_YAML_API_DEFINITIONAcción

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.

Parámetros de entrada

apistringObligatorio
The API name (e.g., 'swaggerhub-portal-api')
ownerstringObligatorio
The owner of the API (e.g., 'smartbear-public')
versionstringObligatorio
The API version (e.g., '0.8.0-beta')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get YAML DefinitionSWAGGERHUB_GET_YAML_DEFINITIONAcción

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.

Parámetros de entrada

apistringObligatorio
API name (case-sensitive). The name of the API as it appears in SwaggerHub.
ownerstringObligatorio
API owner (organization or user, case-sensitive). This is the SwaggerHub username or organization name that owns the API.
flattenboolean
If set to true, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. Default is false.
versionstringObligatorio
Version identifier. The specific version of the API definition to retrieve.
resolvedboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List AttachmentsSWAGGERHUB_LIST_ATTACHMENTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Access Control for TeamsSWAGGERHUB_REMOVE_ACCESS_CONTROL_FOR_TEAMSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Organization identifier
teamsstring[]Obligatorio
Team names to remove access control for
resourceNamestringObligatorio
Name of organizational resource
resourceTypestringObligatorioenum
Organizational resource type (API, DOMAIN, PROJECT, or PORTAL_PRODUCT)
APIDOMAINPROJECTPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Access Control For UsersSWAGGERHUB_REMOVE_ACCESS_CONTROL_FOR_USERSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Organization identifier
usersstring[]Obligatorio
List of members' email addresses to remove access control for
resourceNamestringObligatorio
Name of organizational resource
resourceTypestringObligatorioenum
Organizational resource type (API, DOMAIN, PROJECT, ORGANIZATION, TEAM, or PORTAL_PRODUCT)
APIDOMAINPROJECTORGANIZATIONTEAMPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Organization MembersSWAGGERHUB_REMOVE_MEMBERSAcción

Tool to remove members from a SwaggerHub organization. Use when you need to revoke membership for one or more users by their email addresses.

Parámetros de entrada

userstring[]Obligatorio
Email addresses of the users to remove from the organization. Multiple emails can be provided.
ownerstringObligatorio
Organization identifier (owner name).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search APIsSWAGGERHUB_SEARCH_APISAcción

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.

Parámetros de entrada

pageinteger
Page number to return (0-indexed). Default is 0.
sortstringenum
Enum for sort criteria.
NAMEUPDATEDCREATEDOWNERBEST_MATCHTITLE
limitinteger
Number of results per page (1-100). Default is 10.
orderstringenum
Enum for sort order.
ASCDESC
querystring
Free text query to match against API names and descriptions.
statestringenum
Enum for API published state filter.
ALLPUBLISHEDUNPUBLISHED

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search APIs and DomainsSWAGGERHUB_SEARCH_APIS_AND_DOMAINSAcción

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.

Parámetros de entrada

pageinteger
Page number to return (0-indexed). Default is 0.
sortstringenum
Enum for sort criteria.
NAMEUPDATEDCREATEDOWNERBEST_MATCHTITLE
limitinteger
Number of results per page (1-100). Default is 10.
orderstringenum
Enum for sort order.
ASCDESC
ownerstring
API or domain owner. Can be username or organization name. Case-sensitive.
querystring
Free text query to match against names and descriptions.
statestringenum
Enum for published state filter.
ALLPUBLISHEDUNPUBLISHED
specTypestringenum
Enum for spec type filter.
APIDOMAINTEMPLATEANY
visibilitystringenum
Enum for visibility filter.
PUBLICPRIVATEANY

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search DomainsSWAGGERHUB_SEARCH_DOMAINSAcción

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.

Parámetros de entrada

pageinteger
Page number to return (0-indexed). Default is 0.
sortstringenum
Enum for sort criteria.
NAMEUPDATEDCREATEDOWNERBEST_MATCHTITLE
limitinteger
Number of results per page (1-100). Default is 10.
orderstringenum
Enum for sort order.
ASCDESC
querystring
Free text query to match against domain names and descriptions.
statestringenum
Enum for domain published state filter.
ALLPUBLISHEDUNPUBLISHED

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Published PortalSWAGGERHUB_SEARCH_PUBLISHED_PORTALAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Access Control for TeamsSWAGGERHUB_UPDATE_ACCESS_CONTROL_FOR_TEAMSAcción

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.

Parámetros de entrada

orgIdstringObligatorio
Organization identifier
teamsobject[]Obligatorio
List of teams with their assigned roles to update access control
resourceNamestringObligatorio
Name of the resource to update team access for
resourceTypestringObligatorioenum
Type of the resource (API, DOMAIN, PROJECT, or PORTAL_PRODUCT)
APIDOMAINPROJECTPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Access Control for UsersSWAGGERHUB_UPDATE_ACCESS_CONTROL_FOR_USERSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Organization identifier
usersobject[]Obligatorio
List of users with their assigned roles to update access control
resourceNamestringObligatorio
Name of the organizational resource to update user access for
resourceTypestringObligatorioenum
Type of the organizational resource (API, DOMAIN, PROJECT, ORGANIZATION, TEAM, or PORTAL_PRODUCT)
APIDOMAINPROJECTORGANIZATIONTEAMPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Access Control for TeamsSWAGGERHUB_UPDATE_ACCESS_CONTROL_TEAMSAcción

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.

Parámetros de entrada

ownerstringObligatorio
Organization identifier
teamsobject[]Obligatorio
List of teams with assigned access control. Each team requires a name and role
resourceNamestringObligatorio
Name of organizational resource
resourceTypestringObligatorioenum
Organizational resource type (API, DOMAIN, PROJECT, or PORTAL_PRODUCT)
APIDOMAINPROJECTPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Access Control UsersSWAGGERHUB_UPDATE_ACCESS_CONTROL_USERSAcción

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.

Parámetros de entrada

orgIdstringObligatorio
Organization identifier where the resource is located.
usersobject[]Obligatorio
List of users with their new roles to update on the resource.
resourceNamestringObligatorio
Name of the resource (API, domain, project, etc.) to update user access for.
resourceTypestringObligatorioenum
Type of resource to update user access for: API, DOMAIN, PROJECT, ORGANIZATION, TEAM, or PORTAL_PRODUCT.
APIDOMAINPROJECTORGANIZATIONTEAMPORTAL_PRODUCT

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update PortalSWAGGERHUB_UPDATE_PORTALAcción

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.

Parámetros de entrada

namestring
The name for this portal
footerobject
Footer configuration for the portal.
gtmKeystring
The Google Tag Manager key for this portal. Set to null to remove.
offlineboolean
If set to true, the portal is not visible to customers.
routingstringenum
Routing strategy options.
browserproxy
brandingobject
Branding configuration for the portal.
portalIdstringObligatorio
Portal UUID or subdomain
subdomainstring
Subdomain for this portal. Must be unique.
landingPageobject
Landing page configuration for the portal.
customDomainstring
Custom domain for this portal. Must be unique. If the value is explicitly set to null, the custom domain will be removed.
openapiRendererstringenum
OpenAPI renderer options.
SWAGGER_UIELEMENTSTOGGLE
pageContentFormatstringenum
Page content format options.
BOTHHTMLMARKDOWN
credentialsEnabledboolean
Indicates if credentials are enabled for the portal.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not