# SwaggerHub Registry API API

> SwaggerHub Registry API API on Apizie: 86 endpoints (Search APIs, Get a list of APIs of the specified owner, Get a list of API versions, Create or update an API, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/dev-tools:swaggerhub/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:swaggerhub`
- Category: Dev Tools
- Status: byok
- Source: https://support.smartbear.com/swaggerhub/message/
- Page: https://apizie.tech/api/dev-tools/swaggerhub
- OpenAPI: https://apizie.tech/api/dev-tools/swaggerhub/openapi.json

# Overview Use SwaggerHub Registry API to access, manage, and update the following resources in SwaggerHub, bypassing the web interface: * APIs * Domains * Integrations * Projects * Templates SwaggerHub also provides…

## Endpoints

### Search APIs
`GET https://apizie.tech/v1/dev-tools:swaggerhub/search-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | no | Free text query to match |
| state | string | no | Matches against published state of the spec: * UNPUBLISHED - spec is a draft, a work in progress * PUBLISHED - spec is a stable version… |
| page | integer | no | Page to return |
| limit | integer | no | Number of results per page (1 .. 100) |
| sort | string | no | Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title` |
| order | string | no | Sort order |

### Get a list of APIs of the specified owner
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-owner-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| page | integer | no | Page to return |
| limit | integer | no | Number of results per page (1 .. 100) |
| sort | string | no | Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title` |
| order | string | no | Sort order |

### Get a list of API versions
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-api-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |

### Create or update an API
`POST https://apizie.tech/v1/dev-tools:swaggerhub/save-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner name (organization or user name, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| isPrivate | boolean | no | Whether to make the API private (`true`) or public (`false`) |
| version | string | no | API version to create or update. If omitted, the version is extracted from the `info.version` field of the provided OpenAPI definition.… |
| force | boolean | no | Force update |
| body | object | yes | JSON request body |

### Delete an API
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |

### Rename an API
`POST https://apizie.tech/v1/dev-tools:swaggerhub/rename-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| newName | string | yes | New name |

### Get the default version of an API
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-api-default-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |

### Set the default API version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-api-default-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| body | object | yes | JSON request body |

### Get the OpenAPI definition of the specified API version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| resolved | boolean | no | Set to true to get the resolved version of the API definition. The content of all external $refs will be included in the resulting file. |
| flatten | boolean | no | If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. |

### Delete an API version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-api-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |

### Create a new API version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/clone-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | The version to clone (case-sensitive) |
| body | object | yes | JSON request body |

### Get comments for the specified API version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-api-comments-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |

### Add a new comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/add-api-comment-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Bulk update comments
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-api-comments-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Update a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-api-comment-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| body | object | no | JSON request body |

### Delete a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-api-comment-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |

### Reply to a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/add-api-comment-reply-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| body | object | yes | JSON request body |

### Update a comment reply
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-api-comment-reply-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| reply | string | yes | Reply identifier |
| body | object | no | JSON request body |

### Delete a comment reply
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-api-comment-reply-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| reply | string | yes | Reply identifier |

### Resolve or reopen a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-api-comment-status-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| status | string | yes | Comment status |

### Fork an API
`POST https://apizie.tech/v1/dev-tools:swaggerhub/fork-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Get all integrations configured for the specified API version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-integrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |

### Create an integration for the specified API and version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/create-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Get integration settings
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-integration-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| integrationId | string | yes | Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations` |

### Update integration settings
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| integrationId | string | yes | Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations` |
| body | object | yes | JSON request body |

### Partially update integration settings
`POST https://apizie.tech/v1/dev-tools:swaggerhub/patch-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| integrationId | string | yes | Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations` |
| body | object | yes | JSON request body |

### Delete an integration
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| integrationId | string | yes | Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations` |

### Run an integration
`POST https://apizie.tech/v1/dev-tools:swaggerhub/execute-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| integrationId | string | yes | Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations` |
| commitMessage | string | no | Commit message for source control integrations |

### Get the published status for the specified API and version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-lifecycle-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |

### Publish or unpublish an API version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-lifecycle-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| force | boolean | no | To publish an API that references _unpublished_ domains, this parameter must be `true`. Otherwise, the request will be rejected with… |
| body | object | yes | JSON request body |

### Get the visibility (public or private) of API version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-private-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |

### Set the visibility (public or private) of an API version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-private-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Retrieve the standardization errors for a given API definition
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-standardization-errors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes |  |
| version | string | yes | Version identifier |

### Get the OpenAPI definition for the specified API version in JSON format
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-json-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| resolved | boolean | no | Set to true to get the resolved version of the API definition. The content of all external $refs will be included in the resulting file. |
| flatten | boolean | no | If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. |

### Get the OpenAPI definition for the specified API version in YAML format
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-yaml-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API owner (organization or user, case-sensitive) |
| api | string | yes | API name (case-sensitive) |
| version | string | yes | Version identifier |
| resolved | boolean | no | Set to true to get the resolved version of the API definition. The content of all external $refs will be included in the resulting file. |
| flatten | boolean | no | If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. |

### Search domains
`GET https://apizie.tech/v1/dev-tools:swaggerhub/search-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | no | Free text query to match |
| state | string | no | Matches against published state of the spec: * UNPUBLISHED - spec is a draft, a work in progress * PUBLISHED - spec is a stable version… |
| page | integer | no | Page to return |
| limit | integer | no | Number of results per page (1 .. 100) |
| sort | string | no | Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title` |
| order | string | no | Sort order |

### Get a list of domains of the specified owner
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-owner-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| page | integer | no | Page to return |
| limit | integer | no | Number of results per page (1 .. 100) |
| sort | string | no | Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title` |
| order | string | no | Sort order |

### Get a list of domain versions
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |

### Create or update a domain
`POST https://apizie.tech/v1/dev-tools:swaggerhub/save-domain-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| isPrivate | boolean | no | Specifies whether the domain has to be private |
| version | string | no | Domain version. If omitted, will be taken from the `info.version` field in the definition. |
| force | boolean | no | Force update |
| body | object | no | JSON request body |

### Delete a domain
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| force | boolean | no | If this domain is referenced from other APIs and domains, this parameter must be `true`. Otherwise, the request will be rejected with… |

### Rename a domain
`POST https://apizie.tech/v1/dev-tools:swaggerhub/rename-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| newName | string | yes | New name |
| force | boolean | no | If this domain is referenced from other APIs and domains, this parameter must be true. Otherwise, the request will be rejected with status… |

### Get the default version of a domain
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-default-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |

### Set the default version for a domain
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-domain-default-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| body | object | yes | JSON request body |

### Get the OpenAPI definition of the specified domain version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |

### Delete a domain version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-domain-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| force | boolean | no | If this domain version is referenced from other APIs and domains, this parameter must be `true`. Otherwise, the request will be rejected… |

### Create a new domain version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/clone-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | The version to clone (case-sensitive) |
| body | object | yes | JSON request body |

### Get comments for the specified domain version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-comments-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |

### Add a new comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/add-domain-comment-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Bulk update comments
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-domain-comments-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Update a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-domain-comment-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| body | object | no | JSON request body |

### Delete a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-domain-comment-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |

### Reply to a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/add-domain-comment-reply-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| body | object | yes | JSON request body |

### Update a comment reply
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-domain-comment-reply-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| reply | string | yes | Reply identifier |
| body | object | no | JSON request body |

### Delete a comment reply
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-domain-comment-reply-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| reply | string | yes | Reply identifier |

### Resolve or reopen a comment
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-domain-comment-status-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| comment | string | yes | Comment identifier |
| status | string | yes | Comment status |

### Get the OpenAPI definition for the specified domain version in JSON format
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-json-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |

### Get the OpenAPI definition for the specified domain version in YAML format
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-yaml-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |

### Fork a domain
`POST https://apizie.tech/v1/dev-tools:swaggerhub/fork-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Get the published status for the specified domain and version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-lifecycle-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |

### Publish or unpublish a domain version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-domain-lifecycle-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| force | boolean | no | To publish a domain that references other _unpublished_ domains, this parameter must be `true`. Otherwise, the request will be rejected… |
| body | object | yes | JSON request body |

### Get the visibility (public or private) of a domain version
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-domain-private-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |

### Set the visibility (public or private) of a domain version
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-domain-private-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Domain owner (organization or user, case-sensitive) |
| domain | string | yes | Domain name (case-sensitive) |
| version | string | yes | Version identifier |
| force | boolean | no | To change the visibility from _public_ to _private_ in case this domain is referenced from other _public_ definitions, this parameter must… |
| body | object | yes | JSON request body |

### Get all projects that a user has access to
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-user-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| nameOnly | boolean | no | Return the project information excluding APIs and domains |
| page | integer | no | Page to return |
| limit | integer | no | Number of results per page (1 .. 100) |
| sort | string | no | Sort criteria or result set: * NAME * OWNER |
| order | string | no | Sort order |

### Get all projects of an organization
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-org-projects-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| nameOnly | boolean | no | Return the project information excluding APIs and domains |
| page | integer | no | Page to return |
| limit | integer | no | Number of results per page (1 .. 100) |
| order | string | no | Sort order |

### Create a project in an organization
`POST https://apizie.tech/v1/dev-tools:swaggerhub/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| body | object | yes | JSON request body |

### Get project information
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-project-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| projectId | string | yes | Project name (case-sensitive) |

### Update a project
`POST https://apizie.tech/v1/dev-tools:swaggerhub/save-project-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| projectId | string | yes | Project name (case-sensitive) |
| body | object | yes | JSON request body |

### Delete a project
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-project-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| projectId | string | yes | Project name (case-sensitive) |

### Get project members
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-project-members-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| projectId | string | yes | Project name (case-sensitive) |

### Update a project's members list
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-project-members-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| projectId | string | yes | Project name (case-sensitive) |
| body | object | yes | JSON request body |

### Add an API or domain to a project
`POST https://apizie.tech/v1/dev-tools:swaggerhub/add-spec-to-project-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | Organization name (case-sensitive) |
| projectId | string | yes | Project name (case-sensitive) |
| specType | string | yes | Definition type - `apis` or `domains`. |
| name | string | yes | The name of an API or domain that you want to add to the project. Case-sensitive. |

### Retrieve a list of currently defined APIs, domains, and templates in APIs.json format
`GET https://apizie.tech/v1/dev-tools:swaggerhub/search-apis-and-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| specType | string | no | Type of definitions to search: * API - APIs only * DOMAIN - domains only * TEMPLATE - templates only * ANY - APIs, domains, and templates |
| visibility | string | no | The visibility of a definition in SwaggerHub: * PUBLIC - can be viewed by anyone * PRIVATE - can only be viewed by you or your… |
| state | string | no | Matches against published state of the spec: * UNPUBLISHED - spec is a draft, a work in progress * PUBLISHED - spec is a stable version… |
| owner | string | no | API or domain owner. Can be username or organization name. Case-sensitive. |
| query | string | no | Free text query to match |
| page | integer | no | Page to return |
| limit | integer | no | Number of results per page (1 .. 100) |
| sort | string | no | Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title` |
| order | string | no | Sort order |

### Retrieve a list of templates for an owner
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | no | Owner name |

### Retrieve an APIs.json listing for all template versions for an owner and template
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-template-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |

### Create or update a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/save-template-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| isPrivate | boolean | no | Defines whether the API or template has to be private |
| version | string | no | Template version to create or update. If omitted, the version will be taken from the `info.version` field in the definition. |
| force | boolean | no | Force update |
| projectName | string | no | The project to add the API, domain, or template to |
| body | object | yes | JSON request body |

### Delete a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |

### Rename a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/rename-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| newName | string | yes | New name |

### Retrieve a template definition
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-template-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |
| flatten | boolean | no | If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened. |

### Delete a particular version of a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/delete-template-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |

### Return the list of comments for a template
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-template-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |

### Update the list of comments for a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/update-template-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Create a fork for a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/fork-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

### Retrieve lifecycle settings for a template
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-template-lifecycle-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |

### Update lifecycle settings for a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-template-lifecycle-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |
| force | boolean | no | Force update |
| body | object | yes | JSON request body |

### Retrieve visibility settings for a template
`GET https://apizie.tech/v1/dev-tools:swaggerhub/get-template-private-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |

### Update visibility settings for a template
`POST https://apizie.tech/v1/dev-tools:swaggerhub/set-template-private-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | yes | API, domain, or template owner identifier (case-sensitive) |
| templateId | string | yes | Template identifier |
| version | string | yes | Version identifier |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/dev-tools:swaggerhub/search-apis" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the SwaggerHub Registry API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/dev-tools:swaggerhub/search-apis with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the SwaggerHub Registry API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. SwaggerHub Registry API itself also needs your own key from swaggerhub.com.

### Can AI agents use the SwaggerHub Registry API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key dev-tools:swaggerhub.

### What is the status of the SwaggerHub Registry API API?
Needs your own provider key (bring your own key)