Qodex.ai

Swaggerhub Registry API

Number of APIs: 77

Introduction

Use SwaggerHub Registry API to access, manage, and update your APIs, Domains, and projects in SwaggerHub bypassing the web interface.

SwaggerHub also provides the User Management API to get information about organizations and manage organization members.

SwaggerHub On-Premise notes

This documentation is for SwaggerHub SaaS. On-Premise customers should use the bundled API definition, which can be found at the URLs provided below.

v. 1.29:

http(s)://SERVER/v1/openapi.yaml - YAML version
http(s)://SERVER/v1/openapi.json - JSON version

Earlier versions:

http(s)://SERVER/v1/swagger.yaml - YAML version
http(s)://SERVER/v1/swagger.json - JSON version

Authentication

Operations that update data or access private data require authentication using an API key. You can find your personal API key on the API Keys page in your account settings. Send this key in the Authorization header when making requests to the Registry API:

Authorization: YOUR_API_KEY

To test API calls from this documentation page, click the Authorize button below and paste your API key there.

Important: Keep your API key secure and do not store it directly in your code.

Tools

In addition to calling the Registry API directly, you can use these tools to interact with the API from the command line or CI/CD pipeline:

Contact Support: Name: SwaggerHub Support

  1. apis - Search APIs GET {{baseUrl}}/apis?query=adipisicing aliquip in tempor&state=ALL&page=0&limit=10&sort=NAME&order=ASC

  2. projects-{owner}-{project Id}-members - Get project members GET {{baseUrl}}/projects/:owner/:projectId/members

  3. projects-{owner}-{project Id}-members - Update a project's members list PUT {{baseUrl}}/projects/:owner/:projectId/members

  4. projects-{owner}-{project Id} - Get project information GET {{baseUrl}}/projects/:owner/:projectId

  5. domains-{owner}-{domain}-{version}-comments-{comment} - Delete a comment DELETE {{baseUrl}}/domains/:owner/:domain/:version/comments/:comment

  6. apis-{owner}-{api}-{version}-integrations - Get all integrations configured for the specified API version GET {{baseUrl}}/apis/:owner/:api/:version/integrations

  7. apis-{owner}-{api}-.collaboration - Get API collaborators GET {{baseUrl}}/apis/:owner/:api/.collaboration?expandTeams=false

  8. apis-{owner}-{api}-{version} - Fork an API POST {{baseUrl}}/apis/:owner/:api/:version/fork

  9. apis-{owner}-{api} - Delete an API DELETE {{baseUrl}}/apis/:owner/:api

  10. projects - Get all projects that a user has access to GET {{baseUrl}}/projects?nameOnly=false - DELETE&page=0&limit=10&sort=NAME&order=ASC