rocketkind
DevTools

SwaggerHub

SwaggerHub is SmartBear's registry for OpenAPI and AsyncAPI definitions — APIs and their versions, shared domains, and the published/default state that tells consumers which version is stable.

Authentication

  • API key

Actions

Generic API request. Call any SwaggerHub Registry API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Create or update API definitionCreate a new API, add a version to an existing one, or overwrite an unpublished version, by uploading a complete OpenAPI or AsyncAPI definition as JSON.
  • Delete API versionDestructivePermanently delete one version of an API.
  • Get API definitionDownload the OpenAPI (or AsyncAPI) definition of one API version as a JSON document.
  • Get API versionsList every version of one SwaggerHub API, with each version's published and private flags, and the API's default version in body.defaultVersion.
  • Get domain definitionDownload one version of a SwaggerHub domain — the shared components other API definitions reference with $ref — as a JSON document.
  • Get domain versionsList every version of one SwaggerHub domain, with each version's published and private flags, and the domain's default version in body.defaultVersion.
  • List an owner's APIsList the APIs owned by one SwaggerHub user or organization, one entry per API showing its default version.
  • List an owner's domainsList the domains (reusable components shared between API definitions) owned by one SwaggerHub user or organization, one entry per domain showing its default version.
  • Publish or unpublish API versionDestructivePublish an API version (mark it stable and read-only for consumers) or unpublish it back to an editable draft.
  • Search APIs and domainsSearch the SwaggerHub registry for API definitions, domains and templates by free text, owner, visibility and published state.
  • Set API default versionDestructiveMake one version the API's default — the version SwaggerHub shows and serves when no version is named.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.