> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Swagger

> How to set up the Swagger connector, plus the actions and events that are available.

![Swagger](https://stackone-logos.com/api/swagger/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/swagger/changelog.md)

[62 actions](#actions) · [2 events](#events) · 1 auth method

Developer Tools

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/swagger/guides/connector-profile/api-key.md)
>
> Swagger (SwaggerHub) authenticates with a single account-level API key sent in the Authorization header. The same key is...

Optionally, configure receiving Events for Swagger into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/swagger/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/swagger/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

62 actions

ActionDescription

List Owner APIs`swagger_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`swagger_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`swagger_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`swagger_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`swagger_set_api_default_version`

Set the default version for an API. Provide the version identifier to make default.

Clone API Version`swagger_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`swagger_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`swagger_get_api_standardization`

Run the organization's standardization (API governance) rules against a specific API version and return the violations f...

Get API Validation`swagger_get_api_validation`

Retrieve the validation results (errors and warnings) for a specific API version, reflecting how well the definition con...

Delete API`swagger_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`swagger_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`swagger_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`swagger_get_attachment`

Retrieve the metadata for a single attachment by its ID, including its name, content type and visibility. Use List Attac...

Get Document`swagger_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`swagger_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`swagger_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`swagger_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`swagger_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`swagger_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`swagger_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`swagger_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`swagger_list_api_integrations`

List all integrations configured for a specific API version, including their integration types, names, unique IDs and en...

Get API Integration`swagger_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`swagger_create_api_integration`

Configure a new integration for a specific API version by posting an integration configuration object. The integration t...

Update API Integration`swagger_update_api_integration`

Replace the configuration of an existing integration for an API version. Provide the full integration configuration obje...

Delete API Integration`swagger_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`swagger_list_portals`

List the SwaggerHub portals the caller can access, with optional subdomain filtering and paging. Returns a paged list of...

Create Portal`swagger_create_portal`

Create a new SwaggerHub portal. Requires a subdomain and the swaggerHubOrganizationId (the owning organization's UUID)....

Get Portal`swagger_get_portal`

Retrieve a single SwaggerHub portal by its id. Optionally embed related resources. Use List Portals first to get the por...

Update Portal`swagger_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`swagger_delete_portal`

Soft delete a SwaggerHub portal by its id. Use List Portals first to get the portalId.

List Portal Products`swagger_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`swagger_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`swagger_list_portal_templates`

List the documentation templates available in a specific SwaggerHub portal, with optional name filtering and paging. Use...

Create Portal Template`swagger_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`swagger_list_portal_access_requests`

List the access requests submitted for a specific SwaggerHub portal, with optional status filtering, search and paging....

Get Portal Template`swagger_get_portal_template`

Retrieve a single SwaggerHub Portal template by its ID. Portal templates define reusable documentation layouts and are d...

Update Portal Template`swagger_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`swagger_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`swagger_get_product`

Retrieve a single SwaggerHub Portal product by its ID, optionally embedding related resources. A product is a portal-fac...

Update Product`swagger_update_product`

Update an existing SwaggerHub Portal product. Provide the product ID and a product object with the fields to change (par...

Delete Product`swagger_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`swagger_get_product_sections`

List the sections of a SwaggerHub Portal product, with optional embedding of related resources and pagination. Sections...

Search Published Content`swagger_get_published_content`

Full-text search across a product's published portal content. Provide a search query (3-255 chars) and optionally filter...

List Projects`swagger_list_projects`

List all projects belonging to a specific owner (organization or user) in SwaggerHub, with optional name-only responses...

Create Project`swagger_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`swagger_get_project`

Retrieve a single project by owner and project name, including its included APIs and domains. Use List Projects first to...

Update Project`swagger_update_project`

Update an existing project's data (description and the set of included APIs and domains). Properties that are not provid...

Delete Project`swagger_delete_project`

Permanently delete a project by owner and project name. This removes the project grouping only; the underlying APIs and...

Get Project Members`swagger_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`swagger_add_project_spec`

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`swagger_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`swagger_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`swagger_create_section_table_of_contents`

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`swagger_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`swagger_update_table_of_contents`

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`swagger_delete_table_of_contents`

Delete a table of contents entry by its id. Optionally delete all nested entries recursively. Use Get Section Table of C...

List Templates`swagger_list_templates`

List the API templates available in SwaggerHub, including the built-in templates. Provide the owner handle (username or...

Get Template Versions`swagger_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`swagger_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`swagger_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`swagger_delete_template`

Permanently delete an entire template (all of its versions) owned by a user or organization. This cannot be undone.

## Events

Tags

Select all
|
Clear

APIs

Webhooks

No tags found

2 events

EventDescriptionTags

API Version Saved`swagger_webhook_api_saved`

Emitted when an API version is created or saved in SwaggerHub (the API definition changed). Maps to the SwaggerHub webho...

APIsWebhooks

API Version Published`swagger_webhook_api_published`

Emitted when an API version is published in SwaggerHub. Maps to the SwaggerHub webhook action \`after\_api\_version\_publish...

APIsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.