- List all API definitions owned by a specific user or organization in SwaggerHub, with pagination and sorting. Use the owner handle (username or organization name).
- Retrieve the list of versions for a specific API, returned as an OpenAPI-style document whose entries reference each published version. Use List Owner APIs first to get the owner and API name.
- Retrieve the OpenAPI/Swagger definition for a specific API version as JSON. Optionally resolve external references or flatten the definition. Get the owner, API name and version from Get API Versions.
- Create a new API or save a new/updated version of an existing API by posting an OpenAPI definition. The version is taken from the definition's info.version unless overridden, and the API can be marked private. Use force to overwrite an existing version.
- Set the default version for an API. Provide the version identifier to make default.
- Clone a specific API version into a new API owned by the caller. Cloning copies the definition so it can be modified independently of the source.
- Fork a specific API version, creating a linked copy that tracks its origin. Use fork (rather than clone) when you want to preserve the relationship to the source API.
- Run the organization's standardization (API governance) rules against a specific API version and return the violations found. Use this to check an API against style and governance policies.
- Retrieve the validation results (errors and warnings) for a specific API version, reflecting how well the definition conforms to the OpenAPI specification. Requires API standardization/validation to be configured for the owner organization — returns 404 if no validation is set up for the org.
- Permanently delete an entire API (all of its versions) owned by a user or organization. This cannot be undone — use Delete API Version to remove a single version instead.
- Delete a single version of an API, leaving other versions intact. Provide the owner, API name and the version to remove.
- List all attachments belonging to a SwaggerHub Portal or to a specific product. Filter by either a portal ID or a product ID (the two filters are mutually exclusive).
- Retrieve the metadata for a single attachment by its ID, including its name, content type and visibility. Use List Attachments to find attachment IDs.
- Retrieve the content and metadata of a portal document by its id. A document is the content body behind a table-of-contents entry — the documentId is referenced from a section's table of contents entries (see Get Section Table of Contents).
- Update the contents of a portal document by its id. Provide the document object with the fields to change (e.g. content, type, source). The documentId is referenced from a section's table of contents entries (see Get Section Table of Contents).
- List all domain definitions owned by a specific user or organization in SwaggerHub, with pagination and sorting. Use the owner handle (username or organization name).
- Retrieve the list of versions for a specific domain, returned as an OpenAPI-style document whose entries reference each published version. Use List Owner Domains first to get the owner and domain name.
- Retrieve the OpenAPI/Swagger domain definition for a specific domain version as JSON. Get the owner, domain name and version from Get Domain Versions.
- Create a new domain or save a new/updated version of an existing domain by posting a domain definition. The version is taken from the definition's info.version unless overridden, and the domain can be marked private. Use force to overwrite an existing version.
- Permanently delete an entire domain (all of its versions) owned by a user or organization. This cannot be undone — use Delete Domain Version to remove a single version instead. If the domain is referenced by other APIs or domains, set force to true or the delete is rejected.
- Delete a single version of a domain, leaving other versions intact. Provide the owner, domain name and the version to remove. If the version is referenced by other APIs or domains, set force to true or the delete is rejected.
- List all integrations configured for a specific API version, including their integration types, names, unique IDs and enabled/disabled status. Use Get API Versions to obtain the owner, API name and version.
- Retrieve the full configuration of a single integration for an API version by its ID. Access tokens and passwords are omitted from the response for security. Use List API Integrations to obtain the integration ID.
- Configure a new integration for a specific API version by posting an integration configuration object. The integration type is determined by the configType field inside the configuration. The integration name must be unique for the API version.
- Replace the configuration of an existing integration for an API version. Provide the full integration configuration object; the configType cannot be changed. Use List API Integrations to obtain the integration ID.
- Delete an existing integration from an API version by its ID. This cannot be undone. Use List API Integrations to obtain the integration ID.
- List the SwaggerHub portals the caller can access, with optional subdomain filtering and paging. Returns a paged list of portals with their id, name, subdomain and settings.
- Create a new SwaggerHub portal. Requires a subdomain and the swaggerHubOrganizationId (the owning organization's UUID). Note — swaggerHubOrganizationId is NOT returned by any action in this connector; copy it from Swagger Studio (app.swaggerhub.com) organization settings or the organization page URL. It is a UUID, not the organization handle/name.
- Retrieve a single SwaggerHub portal by its id. Optionally embed related resources. Use List Portals first to get the portalId.
- Update an existing SwaggerHub portal by its id. Provide the portal object with the fields to change. Use List Portals first to get the portalId.
- Soft delete a SwaggerHub portal by its id. Use List Portals first to get the portalId.
- List the products published in a specific SwaggerHub portal, with optional name/slug filtering and paging. Use List Portals first to get the portalId.
- Create a new product within a SwaggerHub portal. The `type` field is a discriminator — set it to 'new' to create a fresh product (send name + slug, do not send productId/templateId) or 'copy' to clone an existing product (productId is REQUIRED, templateId optional). Use List Portals first to get the portalId.
- List the documentation templates available in a specific SwaggerHub portal, with optional name filtering and paging. Use List Portals first to get the portalId.
- Create a new documentation template within a SwaggerHub portal. Provide the template object (e.g. name, description). Use List Portals first to get the portalId. These portal documentation templates are distinct from Registry API templates (see List Templates).
- List the access requests submitted for a specific SwaggerHub portal, with optional status filtering, search and paging. Use List Portals first to get the portalId.
- Retrieve a single SwaggerHub Portal template by its ID. Portal templates define reusable documentation layouts and are distinct from Registry API templates (List Templates). Use List Portal Templates (under a known portalId) to obtain the templateId. Optionally embed related resources.
- Update the details of a SwaggerHub Portal template. Only the properties supplied in the template body are modified (partial update). Use List Portal Templates to obtain the templateId, and Get Portal Template to inspect current values first. This targets Portal templates, not Registry API templates.
- Soft-delete a SwaggerHub Portal template by its ID. The template is marked as removed rather than permanently erased. Use List Portal Templates to obtain the templateId. This targets Portal templates, not Registry API templates.
- Retrieve a single SwaggerHub Portal product by its ID, optionally embedding related resources. A product is a portal-facing documentation product that groups published API content. Use List Portal Products (under a known portalId) to obtain the productId.
- Update an existing SwaggerHub Portal product. Provide the product ID and a product object with the fields to change (partial update). Use List Portal Products to obtain the productId.
- Soft delete a SwaggerHub Portal product by its ID. The product is removed from the portal but can typically be restored by SwaggerHub support. Use List Portal Products to obtain the productId.
- List the sections of a SwaggerHub Portal product, with optional embedding of related resources and pagination. Sections organize the product's content and table of contents. Use List Portal Products to obtain the productId; the returned section ids feed Get Section and Get Section Table of Contents.
- Full-text search across a product's published portal content. Provide a search query (3-255 chars) and optionally filter by result type (DOCUMENT, API, OPERATION, SCHEMA) and paginate the results. Use List Portal Products to obtain the productId. Only PUBLISHED content is searched.
- List all projects belonging to a specific owner (organization or user) in SwaggerHub, with optional name-only responses and pagination. Projects group related APIs and domains together. Provide the owner handle.
- Create a new project for a user or organization, optionally including a set of APIs and domains that belong to the same owner. Projects group related APIs and domains together.
- Retrieve a single project by owner and project name, including its included APIs and domains. Use List Projects first to find the owner and project name.
- Update an existing project's data (description and the set of included APIs and domains). Properties that are not provided are reset to empty values, so send the full desired project state.
- Permanently delete a project by owner and project name. This removes the project grouping only; the underlying APIs and domains are not deleted.
- List the users and teams that are members of a project. Returns each member's name and type (USER or TEAM). Only works for projects owned by an organization — projects under a personal owner return 404.
- Add an existing API or domain to a project. Specify whether the definition is an API or a domain and its name; it must belong to the same owner as the project.
- Retrieve a specific portal section by its id, including its metadata. Optionally embed related resources such as its table of contents. Use Get Product Sections (get_product_sections) first to get the sectionId.
- List the table of contents entries for a specific portal section, with pagination. Optionally embed related resources. Use Get Section first to get the sectionId.
- Add a table of contents entry to a portal section. Provide the entry as an object (a new entry or a copy of an existing one). Use Get Section first to get the sectionId.
- Search across all APIs, domains and templates in SwaggerHub in APIs.json format, with optional filters for spec type, visibility, publication state and owner plus free-text query, pagination and sorting. Returns a paged APIs.json result.
- Update a table of contents entry by its id. Provide the fields to change (e.g. slug, title, order, parentId, content, status). Use Get Section Table of Contents first to get the tableOfContentsId.
- Delete a table of contents entry by its id. Optionally delete all nested entries recursively. Use Get Section Table of Contents first to get the tableOfContentsId.
- List the API templates available in SwaggerHub, including the built-in templates. Provide the owner handle (username or organization name) to additionally include that owner's own templates on top of the always-present built-ins.
- Retrieve the APIs.json listing of all versions for a specific template, identified by its owner and template id. Use List Templates first to get the owner and template id.
- Create a new template or save a new/updated version of an existing template by posting a template definition. The version is taken from the definition's info.version unless overridden, and the template can be marked private. Use force to overwrite an existing version.
- Fork a specific template version into a new template, creating a linked copy that tracks its origin. Provide the target account, new name and version for the fork.
- Permanently delete an entire template (all of its versions) owned by a user or organization. This cannot be undone.
No matching actions