Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
Connector Profile · API Key
Swagger (SwaggerHub) authenticates with a single account-level API key sent in the Authorization header. The same key is…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Link Account · API Key
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
62 actions
Action
Description
List Owner APIs
List all API definitions owned by a specific user or organization in SwaggerHub, with pagination and sorting. Use the ow…
Get API Versions
Retrieve the list of versions for a specific API, returned as an OpenAPI-style document whose entries reference each pub…
Get API Definition
Retrieve the OpenAPI/Swagger definition for a specific API version as JSON. Optionally resolve external references or fl…
Create Or Update API
Create a new API or save a new/updated version of an existing API by posting an OpenAPI definition. The version is taken…
Set API Default Version
Set the default version for an API. Provide the version identifier to make default.
Clone API Version
Clone a specific API version into a new API owned by the caller. Cloning copies the definition so it can be modified ind…
Fork API Version
Fork a specific API version, creating a linked copy that tracks its origin. Use fork (rather than clone) when you want t…
Get API Standardization
Run the organization’s standardization (API governance) rules against a specific API version and return the violations f…
Get API Validation
Retrieve the validation results (errors and warnings) for a specific API version, reflecting how well the definition con…
Delete API
Permanently delete an entire API (all of its versions) owned by a user or organization. This cannot be undone — use Dele…
Delete API Version
Delete a single version of an API, leaving other versions intact. Provide the owner, API name and the version to remove.
List Attachments
List all attachments belonging to a SwaggerHub Portal or to a specific product. Filter by either a portal ID or a produc…
Get Attachment
Retrieve the metadata for a single attachment by its ID, including its name, content type and visibility. Use List Attac…
Get Document
Retrieve the content and metadata of a portal document by its id. A document is the content body behind a table-of-conte…
Update Document
Update the contents of a portal document by its id. Provide the document object with the fields to change (e.g. content,…
List Owner Domains
List all domain definitions owned by a specific user or organization in SwaggerHub, with pagination and sorting. Use the…
Get Domain Versions
Retrieve the list of versions for a specific domain, returned as an OpenAPI-style document whose entries reference each…
Get Domain Definition
Retrieve the OpenAPI/Swagger domain definition for a specific domain version as JSON. Get the owner, domain name and ver…
Create Or Update Domain
Create a new domain or save a new/updated version of an existing domain by posting a domain definition. The version is t…
Delete Domain
Permanently delete an entire domain (all of its versions) owned by a user or organization. This cannot be undone — use D…
Delete Domain Version
Delete a single version of a domain, leaving other versions intact. Provide the owner, domain name and the version to re…
List API Integrations
List all integrations configured for a specific API version, including their integration types, names, unique IDs and en…
Get API Integration
Retrieve the full configuration of a single integration for an API version by its ID. Access tokens and passwords are om…
Create API Integration
Configure a new integration for a specific API version by posting an integration configuration object. The integration t…
Update API Integration
Replace the configuration of an existing integration for an API version. Provide the full integration configuration obje…
Delete API Integration
Delete an existing integration from an API version by its ID. This cannot be undone. Use List API Integrations to obtain…
List Portals
List the SwaggerHub portals the caller can access, with optional subdomain filtering and paging. Returns a paged list of…
Create Portal
Create a new SwaggerHub portal. Requires a subdomain and the swaggerHubOrganizationId (the owning organization’s UUID)…
Get Portal
Retrieve a single SwaggerHub portal by its id. Optionally embed related resources. Use List Portals first to get the por…
Update Portal
Update an existing SwaggerHub portal by its id. Provide the portal object with the fields to change. Use List Portals fi…
Delete Portal
Soft delete a SwaggerHub portal by its id. Use List Portals first to get the portalId.
List Portal Products
List the products published in a specific SwaggerHub portal, with optional name/slug filtering and paging. Use List Port…
Create Portal Product
Create a new product within a SwaggerHub portal. The
type field is a discriminator — set it to ‘new’ to create a fresh…List Portal Templates
List the documentation templates available in a specific SwaggerHub portal, with optional name filtering and paging. Use…
Create Portal Template
Create a new documentation template within a SwaggerHub portal. Provide the template object (e.g. name, description). Us…
List Portal Access Requests
List the access requests submitted for a specific SwaggerHub portal, with optional status filtering, search and paging…
Get Portal Template
Retrieve a single SwaggerHub Portal template by its ID. Portal templates define reusable documentation layouts and are d…
Update Portal Template
Update the details of a SwaggerHub Portal template. Only the properties supplied in the template body are modified (part…
Delete Portal Template
Soft-delete a SwaggerHub Portal template by its ID. The template is marked as removed rather than permanently erased. Us…
Get Product
Retrieve a single SwaggerHub Portal product by its ID, optionally embedding related resources. A product is a portal-fac…
Update Product
Update an existing SwaggerHub Portal product. Provide the product ID and a product object with the fields to change (par…
Delete Product
Soft delete a SwaggerHub Portal product by its ID. The product is removed from the portal but can typically be restored…
Get Product Sections
List the sections of a SwaggerHub Portal product, with optional embedding of related resources and pagination. Sections…
Search Published Content
Full-text search across a product’s published portal content. Provide a search query (3-255 chars) and optionally filter…
List Projects
List all projects belonging to a specific owner (organization or user) in SwaggerHub, with optional name-only responses…
Create Project
Create a new project for a user or organization, optionally including a set of APIs and domains that belong to the same…
Get Project
Retrieve a single project by owner and project name, including its included APIs and domains. Use List Projects first to…
Update Project
Update an existing project’s data (description and the set of included APIs and domains). Properties that are not provid…
Delete Project
Permanently delete a project by owner and project name. This removes the project grouping only; the underlying APIs and…
Get Project Members
List the users and teams that are members of a project. Returns each member’s name and type (USER or TEAM). Only works f…
Add API Or Domain To Project
Add an existing API or domain to a project. Specify whether the definition is an API or a domain and its name; it must b…
Get Section
Retrieve a specific portal section by its id, including its metadata. Optionally embed related resources such as its tab…
Get Section Table Of Contents
List the table of contents entries for a specific portal section, with pagination. Optionally embed related resources. U…
Create Section Table Of Contents Entry
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…
Search APIs And Domains
Search across all APIs, domains and templates in SwaggerHub in APIs.json format, with optional filters for spec type, vi…
Update Table Of Contents Entry
Update a table of contents entry by its id. Provide the fields to change (e.g. slug, title, order, parentId, content, st…
Delete Table Of Contents Entry
Delete a table of contents entry by its id. Optionally delete all nested entries recursively. Use Get Section Table of C…
List Templates
List the API templates available in SwaggerHub, including the built-in templates. Provide the owner handle (username or…
Get Template Versions
Retrieve the APIs.json listing of all versions for a specific template, identified by its owner and template id. Use Lis…
Create Or Update Template
Create a new template or save a new/updated version of an existing template by posting a template definition. The versio…
Fork Template Version
Fork a specific template version into a new template, creating a linked copy that tracks its origin. Provide the target…
Delete Template
Permanently delete an entire template (all of its versions) owned by a user or organization. This cannot be undone.