> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # swaggerhub > SwaggerHub API Registry **Server path:** `/swaggerhub` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | [`swaggerhub_add_api_comment_reply_v2`](#swaggerhub_add_api_comment_reply_v2) | Reply to a comment | | [`swaggerhub_add_api_comment_v2`](#swaggerhub_add_api_comment_v2) | Add a new comment | | [`swaggerhub_add_domain_comment_reply_v2`](#swaggerhub_add_domain_comment_reply_v2) | Reply to a comment | | [`swaggerhub_add_domain_comment_v2`](#swaggerhub_add_domain_comment_v2) | Add a new comment | | [`swaggerhub_add_spec_to_project_v2`](#swaggerhub_add_spec_to_project_v2) | Add an API or domain to a project | | [`swaggerhub_clone_api`](#swaggerhub_clone_api) | Create a new API version | | [`swaggerhub_clone_domain`](#swaggerhub_clone_domain) | Create a new domain version | | [`swaggerhub_create_integration`](#swaggerhub_create_integration) | Create an integration for the specified API and version | | [`swaggerhub_create_project`](#swaggerhub_create_project) | Create a project in an organization | | [`swaggerhub_delete_api`](#swaggerhub_delete_api) | Delete an API | | [`swaggerhub_delete_api_comment_reply_v2`](#swaggerhub_delete_api_comment_reply_v2) | Delete a comment reply | | [`swaggerhub_delete_api_comment_v2`](#swaggerhub_delete_api_comment_v2) | Delete a comment | | [`swaggerhub_delete_api_version`](#swaggerhub_delete_api_version) | Delete an API version | | [`swaggerhub_delete_domain`](#swaggerhub_delete_domain) | Delete a domain | | [`swaggerhub_delete_domain_comment_reply_v2`](#swaggerhub_delete_domain_comment_reply_v2) | Delete a comment reply | | [`swaggerhub_delete_domain_comment_v2`](#swaggerhub_delete_domain_comment_v2) | Delete a comment | | [`swaggerhub_delete_domain_version`](#swaggerhub_delete_domain_version) | Delete a domain version | | [`swaggerhub_delete_integration`](#swaggerhub_delete_integration) | Delete an integration | | [`swaggerhub_delete_project_v2`](#swaggerhub_delete_project_v2) | Delete a project | | [`swaggerhub_delete_template`](#swaggerhub_delete_template) | Delete a template | | [`swaggerhub_delete_template_version`](#swaggerhub_delete_template_version) | Delete a particular version of a template | | [`swaggerhub_execute_integration`](#swaggerhub_execute_integration) | Run an integration | | [`swaggerhub_fork_api`](#swaggerhub_fork_api) | Fork an API | | [`swaggerhub_fork_domain`](#swaggerhub_fork_domain) | Fork a domain | | [`swaggerhub_fork_template`](#swaggerhub_fork_template) | Create a fork for a template | | [`swaggerhub_get_api_comments_v2`](#swaggerhub_get_api_comments_v2) | Get comments for the specified API version | | [`swaggerhub_get_api_default_version`](#swaggerhub_get_api_default_version) | Get the default version of an API | | [`swaggerhub_get_api_versions`](#swaggerhub_get_api_versions) | Get a list of API versions | | [`swaggerhub_get_definition`](#swaggerhub_get_definition) | Get the OpenAPI definition of the specified API version | | [`swaggerhub_get_domain_comments_v2`](#swaggerhub_get_domain_comments_v2) | Get comments for the specified domain version | | [`swaggerhub_get_domain_default_version`](#swaggerhub_get_domain_default_version) | Get the default version of a domain | | [`swaggerhub_get_domain_definition`](#swaggerhub_get_domain_definition) | Get the OpenAPI definition of the specified domain version | | [`swaggerhub_get_domain_json_definition`](#swaggerhub_get_domain_json_definition) | Get the OpenAPI definition for the specified domain version in JSON format | | [`swaggerhub_get_domain_lifecycle_settings`](#swaggerhub_get_domain_lifecycle_settings) | Get the published status for the specified domain and version | | [`swaggerhub_get_domain_private_settings`](#swaggerhub_get_domain_private_settings) | Get the visibility (public or private) of a domain version | | [`swaggerhub_get_domain_versions`](#swaggerhub_get_domain_versions) | Get a list of domain versions | | [`swaggerhub_get_domain_yaml_definition`](#swaggerhub_get_domain_yaml_definition) | Get the OpenAPI definition for the specified domain version in YAML format | | [`swaggerhub_get_integration_by_id`](#swaggerhub_get_integration_by_id) | Get integration settings | | [`swaggerhub_get_integrations`](#swaggerhub_get_integrations) | Get all integrations configured for the specified API version | | [`swaggerhub_get_json_definition`](#swaggerhub_get_json_definition) | Get the OpenAPI definition for the specified API version in JSON format | | [`swaggerhub_get_lifecycle_settings`](#swaggerhub_get_lifecycle_settings) | Get the published status for the specified API and version | | [`swaggerhub_get_org_projects_v2`](#swaggerhub_get_org_projects_v2) | Get all projects of an organization | | [`swaggerhub_get_owner_apis`](#swaggerhub_get_owner_apis) | Get a list of APIs of the specified owner | | [`swaggerhub_get_owner_domains`](#swaggerhub_get_owner_domains) | Get a list of domains of the specified owner | | [`swaggerhub_get_private_settings`](#swaggerhub_get_private_settings) | Get the visibility (public or private) of API version | | [`swaggerhub_get_project_members_v2`](#swaggerhub_get_project_members_v2) | Get project members | | [`swaggerhub_get_project_v2`](#swaggerhub_get_project_v2) | Get project information | | [`swaggerhub_get_standardization_errors`](#swaggerhub_get_standardization_errors) | Retrieve the standardization errors for a given API definition | | [`swaggerhub_get_template_comments`](#swaggerhub_get_template_comments) | Return the list of comments for a template | | [`swaggerhub_get_template_definition`](#swaggerhub_get_template_definition) | Retrieve a template definition | | [`swaggerhub_get_template_lifecycle_settings`](#swaggerhub_get_template_lifecycle_settings) | Retrieve lifecycle settings for a template | | [`swaggerhub_get_template_private_settings`](#swaggerhub_get_template_private_settings) | Retrieve visibility settings for a template | | [`swaggerhub_get_template_versions`](#swaggerhub_get_template_versions) | Retrieve an APIs.json listing for all template versions for an owner and template | | [`swaggerhub_get_templates`](#swaggerhub_get_templates) | Retrieve a list of templates for an owner | | [`swaggerhub_get_user_projects`](#swaggerhub_get_user_projects) | Get all projects that a user has access to | | [`swaggerhub_get_yaml_definition`](#swaggerhub_get_yaml_definition) | Get the OpenAPI definition for the specified API version in YAML format | | [`swaggerhub_patch_integration`](#swaggerhub_patch_integration) | Partially update integration settings | | [`swaggerhub_rename_api`](#swaggerhub_rename_api) | Rename an API | | [`swaggerhub_rename_domain`](#swaggerhub_rename_domain) | Rename a domain | | [`swaggerhub_rename_template`](#swaggerhub_rename_template) | Rename a template | | [`swaggerhub_save_definition`](#swaggerhub_save_definition) | Create or update an API | | [`swaggerhub_save_domain_definition`](#swaggerhub_save_domain_definition) | Create or update a domain | | [`swaggerhub_save_project_v2`](#swaggerhub_save_project_v2) | Update a project | | [`swaggerhub_save_template_definition`](#swaggerhub_save_template_definition) | Create or update a template | | [`swaggerhub_search_apis`](#swaggerhub_search_apis) | Search APIs | | [`swaggerhub_search_apis_and_domains`](#swaggerhub_search_apis_and_domains) | Retrieve a list of currently defined APIs, domains, and templates in APIs.json format | | [`swaggerhub_search_domains`](#swaggerhub_search_domains) | Search domains | | [`swaggerhub_set_api_comment_status_v2`](#swaggerhub_set_api_comment_status_v2) | Resolve or reopen a comment | | [`swaggerhub_set_api_default_version`](#swaggerhub_set_api_default_version) | Set the default API version | | [`swaggerhub_set_domain_comment_status_v2`](#swaggerhub_set_domain_comment_status_v2) | Resolve or reopen a comment | | [`swaggerhub_set_domain_default_version`](#swaggerhub_set_domain_default_version) | Set the default version for a domain | | [`swaggerhub_set_domain_lifecycle_settings`](#swaggerhub_set_domain_lifecycle_settings) | Publish or unpublish a domain version | | [`swaggerhub_set_domain_private_settings`](#swaggerhub_set_domain_private_settings) | Set the visibility (public or private) of a domain version | | [`swaggerhub_set_lifecycle_settings`](#swaggerhub_set_lifecycle_settings) | Publish or unpublish an API version | | [`swaggerhub_set_private_settings`](#swaggerhub_set_private_settings) | Set the visibility (public or private) of an API version | | [`swaggerhub_set_template_lifecycle_settings`](#swaggerhub_set_template_lifecycle_settings) | Update lifecycle settings for a template | | [`swaggerhub_set_template_private_settings`](#swaggerhub_set_template_private_settings) | Update visibility settings for a template | | [`swaggerhub_update_api_comment_reply_v2`](#swaggerhub_update_api_comment_reply_v2) | Update a comment reply | | [`swaggerhub_update_api_comment_v2`](#swaggerhub_update_api_comment_v2) | Update a comment | | [`swaggerhub_update_api_comments_v2`](#swaggerhub_update_api_comments_v2) | Bulk update comments | | [`swaggerhub_update_domain_comment_reply_v2`](#swaggerhub_update_domain_comment_reply_v2) | Update a comment reply | | [`swaggerhub_update_domain_comment_v2`](#swaggerhub_update_domain_comment_v2) | Update a comment | | [`swaggerhub_update_domain_comments_v2`](#swaggerhub_update_domain_comments_v2) | Bulk update comments | | [`swaggerhub_update_integration`](#swaggerhub_update_integration) | Update integration settings | | [`swaggerhub_update_project_members_v2`](#swaggerhub_update_project_members_v2) | Update a project's members list | | [`swaggerhub_update_template_comments`](#swaggerhub_update_template_comments) | Update the list of comments for a template | *** ## swaggerhub\_add\_api\_comment\_reply\_v2 Reply to a comment **Parameters:** | Parameter | Type | Required | Default | 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` | string | Yes | — | The reply text content | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "body": { "type": "string", "description": "The reply text content" } }, "required": [ "PCID", "owner", "api", "version", "comment", "body" ] } ``` *** ## swaggerhub\_add\_api\_comment\_v2 Add a new comment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | | `body` | string | Yes | — | The body value | | `position` | integer | Yes | — | The position value | | `replies` | object\[] | No | — | The replies value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "body": { "type": "string", "description": "The body value" }, "position": { "type": "integer", "description": "The position value" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value" } }, "required": [ "body" ] }, "description": "The replies value" } }, "required": [ "PCID", "owner", "api", "version", "body", "position" ] } ``` *** ## swaggerhub\_add\_domain\_comment\_reply\_v2 Reply to a comment **Parameters:** | Parameter | Type | Required | Default | 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` | string | Yes | — | The reply text content | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "body": { "type": "string", "description": "The reply text content" } }, "required": [ "PCID", "owner", "domain", "version", "comment", "body" ] } ``` *** ## swaggerhub\_add\_domain\_comment\_v2 Add a new comment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | | `body` | string | Yes | — | The body value | | `position` | integer | Yes | — | The position value | | `replies` | object\[] | No | — | The replies value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "body": { "type": "string", "description": "The body value" }, "position": { "type": "integer", "description": "The position value" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value" } }, "required": [ "body" ] }, "description": "The replies value" } }, "required": [ "PCID", "owner", "domain", "version", "body", "position" ] } ``` *** ## swaggerhub\_add\_spec\_to\_project\_v2 Add an API or domain to a project **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "projectId": { "type": "string", "description": "Project name (case-sensitive)" }, "specType": { "type": "string", "description": "Definition type - `apis` or `domains`.", "enum": [ "apis", "domains" ] }, "name": { "type": "string", "description": "The name of an API or domain that you want to add to the project. Case-sensitive." } }, "required": [ "PCID", "owner", "projectId", "specType", "name" ] } ``` *** ## swaggerhub\_clone\_api Create a new API version **Parameters:** | Parameter | Type | Required | Default | 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) | | `newVersion` | string | Yes | — | The version identifier for the new cloned version | | `private` | boolean | No | — | Whether the new version should be public (`false`) or private (`true`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "The version to clone (case-sensitive)" }, "newVersion": { "type": "string", "description": "The version identifier for the new cloned version" }, "private": { "type": "boolean", "description": "Whether the new version should be public (`false`) or private (`true`)" } }, "required": [ "PCID", "owner", "api", "version", "newVersion" ] } ``` *** ## swaggerhub\_clone\_domain Create a new domain version **Parameters:** | Parameter | Type | Required | Default | 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) | | `newVersion` | string | Yes | — | The version identifier for the new cloned version | | `private` | boolean | No | — | Whether the new version should be public (`false`) or private (`true`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "The version to clone (case-sensitive)" }, "newVersion": { "type": "string", "description": "The version identifier for the new cloned version" }, "private": { "type": "boolean", "description": "Whether the new version should be public (`false`) or private (`true`)" } }, "required": [ "PCID", "owner", "domain", "version", "newVersion" ] } ``` *** ## swaggerhub\_create\_integration Create an integration for the specified API and version **Parameters:** | Parameter | Type | Required | Default | 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 | — | Can be one of the following objects: \| `configType` value \| Object \| \| ------------------------- \| ------ \| \| AMAZON\_API\_GATEWAY \| AmazonApiGatewayIntegration \| \| AMAZON\_API\_GATEWAY\_LAMBDA \| AmazonApiGatewayLambdaIntegration \| \| API\_AUTO\_MOCKING \| AutoMockingIntegration \| \| APIGEE\_EDGE \| ApigeeEdgeIntegration \| \| AZURE\_API\_MANAGEMENT \| AzureApiManagementIntegration \| \| AZURE\_DEVOPS\_SERVICES \| AzureDevopsServicesIntegration \| \| BITBUCKET\_CLOUD \| BitbucketCloudIntegration \| \| BITBUCKET\_SERVER \| BitbucketServerIntegration \| \| GITHUB \| GitHubIntegration \| \| GITHUB\_ENTERPRISE \| GitHubEnterpriseIntegration \| \| GITLAB \| GitLabIntegration \| \| IBM\_API\_CONNECT \| IBMApiConnectIntegration \| \| WEBHOOK \| WebhookIntegration \| For more examples, see the JSON files in this repository: [https://github.com/SmartBear/swaggerhub-cli/tree/master/examples/integrations](https://github.com/SmartBear/swaggerhub-cli/tree/master/examples/integrations) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "body": { "type": "object", "description": "Can be one of the following objects: | `configType` value | Object | | ------------------------- | ------ | | AMAZON_API_GATEWAY | AmazonApiGatewayIntegration | | AMAZON_API_GATEWAY_LAMBDA | AmazonApiGatewayLambdaIntegration | | API_AUTO_MOCKING | AutoMockingIntegration | | APIGEE_EDGE | ApigeeEdgeIntegration | | AZURE_API_MANAGEMENT | AzureApiManagementIntegration | | AZURE_DEVOPS_SERVICES | AzureDevopsServicesIntegration | | BITBUCKET_CLOUD | BitbucketCloudIntegration | | BITBUCKET_SERVER | BitbucketServerIntegration | | GITHUB | GitHubIntegration | | GITHUB_ENTERPRISE | GitHubEnterpriseIntegration | | GITLAB | GitLabIntegration | | IBM_API_CONNECT | IBMApiConnectIntegration | | WEBHOOK | WebhookIntegration | For more examples, see the JSON files in this repository: https://github.com/SmartBear/swaggerhub-cli/tree/master/examples/integrations" } }, "required": [ "PCID", "owner", "api", "version", "body" ] } ``` *** ## swaggerhub\_create\_project Create a project in an organization **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `owner` | string | Yes | — | Organization name (case-sensitive) | | `apis` | string\[] | No | — | A list of APIs included in this project. The APIs must belong to the same owner as the project. API names are case-sensitive. | | `description` | string | No | — | Project description | | `domains` | string\[] | No | — | A list of domains included in this project. The domains must belong to the same owner as the project. Domain names are case-sensitive. | | `name` | string | No | — | Project name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "apis": { "type": "array", "items": { "type": "string" }, "description": "A list of APIs included in this project. The APIs must belong to the same owner as the project. API names are case-sensitive." }, "description": { "type": "string", "description": "Project description" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "A list of domains included in this project. The domains must belong to the same owner as the project. Domain names are case-sensitive." }, "name": { "type": "string", "description": "Project name" } }, "required": [ "PCID", "owner" ] } ``` *** ## swaggerhub\_delete\_api Delete an API **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" } }, "required": [ "PCID", "owner", "api" ] } ``` *** ## swaggerhub\_delete\_api\_comment\_reply\_v2 Delete a comment reply **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "reply": { "type": "string", "description": "Reply identifier" } }, "required": [ "PCID", "owner", "api", "version", "comment", "reply" ] } ``` *** ## swaggerhub\_delete\_api\_comment\_v2 Delete a comment **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" } }, "required": [ "PCID", "owner", "api", "version", "comment" ] } ``` *** ## swaggerhub\_delete\_api\_version Delete an API version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_delete\_domain Delete a domain **Parameters:** | Parameter | Type | Required | Default | 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 status code 424. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "force": { "type": "boolean", "description": "If this domain is referenced from other APIs and domains, this parameter must be `true`. Otherwise, the request will be rejected with status code 424." } }, "required": [ "PCID", "owner", "domain" ] } ``` *** ## swaggerhub\_delete\_domain\_comment\_reply\_v2 Delete a comment reply **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "reply": { "type": "string", "description": "Reply identifier" } }, "required": [ "PCID", "owner", "domain", "version", "comment", "reply" ] } ``` *** ## swaggerhub\_delete\_domain\_comment\_v2 Delete a comment **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" } }, "required": [ "PCID", "owner", "domain", "version", "comment" ] } ``` *** ## swaggerhub\_delete\_domain\_version Delete a domain version **Parameters:** | Parameter | Type | Required | Default | 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 with status code 424. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "force": { "type": "boolean", "description": "If this domain version is referenced from other APIs and domains, this parameter must be `true`. Otherwise, the request will be rejected with status code 424." } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_delete\_integration Delete an integration **Parameters:** | Parameter | Type | Required | Default | 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` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "integrationId": { "type": "string", "description": "Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations`" } }, "required": [ "PCID", "owner", "api", "version", "integrationId" ] } ``` *** ## swaggerhub\_delete\_project\_v2 Delete a project **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------- | | `owner` | string | Yes | — | Organization name (case-sensitive) | | `projectId` | string | Yes | — | Project name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "projectId": { "type": "string", "description": "Project name (case-sensitive)" } }, "required": [ "PCID", "owner", "projectId" ] } ``` *** ## swaggerhub\_delete\_template Delete a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" } }, "required": [ "PCID", "owner", "templateId" ] } ``` *** ## swaggerhub\_delete\_template\_version Delete a particular version of a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "templateId", "version" ] } ``` *** ## swaggerhub\_execute\_integration Run an integration **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "integrationId": { "type": "string", "description": "Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations`" }, "commitMessage": { "type": "string", "description": "Commit message for source control integrations" } }, "required": [ "PCID", "owner", "api", "version", "integrationId" ] } ``` *** ## swaggerhub\_fork\_api Fork an API **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | | `name` | string | Yes | — | The name for the forked definition. Must follow the [naming rules](https://support.smartbear.com/swaggerhub/docs/apis/creating-api.html). Can be the name of an existing definition, in which case the fork will become a new version in that definition, unless that version already exists. | | `private` | boolean | No | — | Whether the forked version should be public (`false`) or private (`true`). If the value is not set, the original version's setting will be used. | | `project` | string | No | — | If forking into an organization, you can optionally specify an existing project to add the forked definition to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "name": { "type": "string", "description": "The name for the forked definition. Must follow the [naming rules](https://support.smartbear.com/swaggerhub/docs/apis/creating-api.html). Can be the name of an existing definition, in which case the fork will become a new version in that definition, unless that version already exists." }, "private": { "type": "boolean", "description": "Whether the forked version should be public (`false`) or private (`true`). If the value is not set, the original version's setting will be used." }, "project": { "type": "string", "description": "If forking into an organization, you can optionally specify an existing project to add the forked definition to." } }, "required": [ "PCID", "owner", "api", "version", "name" ] } ``` *** ## swaggerhub\_fork\_domain Fork a domain **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | | `name` | string | Yes | — | The name for the forked definition. Must follow the [naming rules](https://support.smartbear.com/swaggerhub/docs/apis/creating-api.html). Can be the name of an existing definition, in which case the fork will become a new version in that definition, unless that version already exists. | | `private` | boolean | No | — | Whether the forked version should be public (`false`) or private (`true`). If the value is not set, the original version's setting will be used. | | `project` | string | No | — | If forking into an organization, you can optionally specify an existing project to add the forked definition to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "name": { "type": "string", "description": "The name for the forked definition. Must follow the [naming rules](https://support.smartbear.com/swaggerhub/docs/apis/creating-api.html). Can be the name of an existing definition, in which case the fork will become a new version in that definition, unless that version already exists." }, "private": { "type": "boolean", "description": "Whether the forked version should be public (`false`) or private (`true`). If the value is not set, the original version's setting will be used." }, "project": { "type": "string", "description": "If forking into an organization, you can optionally specify an existing project to add the forked definition to." } }, "required": [ "PCID", "owner", "domain", "version", "name" ] } ``` *** ## swaggerhub\_fork\_template Create a fork for a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `version` | string | Yes | — | Version identifier | | `name` | string | Yes | — | The name for the forked definition. Must follow the [naming rules](https://support.smartbear.com/swaggerhub/docs/apis/creating-api.html). Can be the name of an existing definition, in which case the fork will become a new version in that definition, unless that version already exists. | | `private` | boolean | No | — | Whether the forked version should be public (`false`) or private (`true`). If the value is not set, the original version's setting will be used. | | `project` | string | No | — | If forking into an organization, you can optionally specify an existing project to add the forked definition to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" }, "name": { "type": "string", "description": "The name for the forked definition. Must follow the [naming rules](https://support.smartbear.com/swaggerhub/docs/apis/creating-api.html). Can be the name of an existing definition, in which case the fork will become a new version in that definition, unless that version already exists." }, "private": { "type": "boolean", "description": "Whether the forked version should be public (`false`) or private (`true`). If the value is not set, the original version's setting will be used." }, "project": { "type": "string", "description": "If forking into an organization, you can optionally specify an existing project to add the forked definition to." } }, "required": [ "PCID", "owner", "templateId", "version", "name" ] } ``` *** ## swaggerhub\_get\_api\_comments\_v2 Get comments for the specified API version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_get\_api\_default\_version Get the default version of an API **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" } }, "required": [ "PCID", "owner", "api" ] } ``` *** ## swaggerhub\_get\_api\_versions Get a list of API versions **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" } }, "required": [ "PCID", "owner", "api" ] } ``` *** ## swaggerhub\_get\_definition Get the OpenAPI definition of the specified API version **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "resolved": { "type": "boolean", "description": "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": { "type": "boolean", "description": "If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened." } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_get\_domain\_comments\_v2 Get comments for the specified domain version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_get\_domain\_default\_version Get the default version of a domain **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" } }, "required": [ "PCID", "owner", "domain" ] } ``` *** ## swaggerhub\_get\_domain\_definition Get the OpenAPI definition of the specified domain version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_get\_domain\_json\_definition Get the OpenAPI definition for the specified domain version in JSON format **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_get\_domain\_lifecycle\_settings Get the published status for the specified domain and version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_get\_domain\_private\_settings Get the visibility (public or private) of a domain version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_get\_domain\_versions Get a list of domain versions **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" } }, "required": [ "PCID", "owner", "domain" ] } ``` *** ## swaggerhub\_get\_domain\_yaml\_definition Get the OpenAPI definition for the specified domain version in YAML format **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_get\_integration\_by\_id Get integration settings **Parameters:** | Parameter | Type | Required | Default | 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` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "integrationId": { "type": "string", "description": "Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations`" } }, "required": [ "PCID", "owner", "api", "version", "integrationId" ] } ``` *** ## swaggerhub\_get\_integrations Get all integrations configured for the specified API version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_get\_json\_definition Get the OpenAPI definition for the specified API version in JSON format **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "resolved": { "type": "boolean", "description": "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": { "type": "boolean", "description": "If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened." } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_get\_lifecycle\_settings Get the published status for the specified API and version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_get\_org\_projects\_v2 Get all projects of an organization **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "nameOnly": { "type": "boolean", "description": "Return the project information excluding APIs and domains" }, "page": { "type": "integer", "description": "Page to return" }, "limit": { "type": "integer", "description": "Number of results per page (1 .. 100)" }, "order": { "type": "string", "description": "Sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID", "owner" ] } ``` *** ## swaggerhub\_get\_owner\_apis Get a list of APIs of the specified owner **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "page": { "type": "integer", "description": "Page to return" }, "limit": { "type": "integer", "description": "Number of results per page (1 .. 100)" }, "sort": { "type": "string", "description": "Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title`", "enum": [ "NAME", "UPDATED", "CREATED", "OWNER", "BEST_MATCH", "TITLE" ] }, "order": { "type": "string", "description": "Sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID", "owner" ] } ``` *** ## swaggerhub\_get\_owner\_domains Get a list of domains of the specified owner **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "page": { "type": "integer", "description": "Page to return" }, "limit": { "type": "integer", "description": "Number of results per page (1 .. 100)" }, "sort": { "type": "string", "description": "Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title`", "enum": [ "NAME", "UPDATED", "CREATED", "OWNER", "BEST_MATCH", "TITLE" ] }, "order": { "type": "string", "description": "Sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID", "owner" ] } ``` *** ## swaggerhub\_get\_private\_settings Get the visibility (public or private) of API version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_get\_project\_members\_v2 Get project members **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------- | | `owner` | string | Yes | — | Organization name (case-sensitive) | | `projectId` | string | Yes | — | Project name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "projectId": { "type": "string", "description": "Project name (case-sensitive)" } }, "required": [ "PCID", "owner", "projectId" ] } ``` *** ## swaggerhub\_get\_project\_v2 Get project information **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------- | | `owner` | string | Yes | — | Organization name (case-sensitive) | | `projectId` | string | Yes | — | Project name (case-sensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "projectId": { "type": "string", "description": "Project name (case-sensitive)" } }, "required": [ "PCID", "owner", "projectId" ] } ``` *** ## swaggerhub\_get\_standardization\_errors Retrieve the standardization errors for a given API definition **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | The api value | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "The api value" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_get\_template\_comments Return the list of comments for a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "templateId", "version" ] } ``` *** ## swaggerhub\_get\_template\_definition Retrieve a template definition **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" }, "flatten": { "type": "boolean", "description": "If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened." } }, "required": [ "PCID", "owner", "templateId", "version" ] } ``` *** ## swaggerhub\_get\_template\_lifecycle\_settings Retrieve lifecycle settings for a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "templateId", "version" ] } ``` *** ## swaggerhub\_get\_template\_private\_settings Retrieve visibility settings for a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `version` | string | Yes | — | Version identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" } }, "required": [ "PCID", "owner", "templateId", "version" ] } ``` *** ## swaggerhub\_get\_template\_versions Retrieve an APIs.json listing for all template versions for an owner and template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" } }, "required": [ "PCID", "owner", "templateId" ] } ``` *** ## swaggerhub\_get\_templates Retrieve a list of templates for an owner **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `owner` | string | No | — | Owner name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Owner name" } }, "required": [ "PCID" ] } ``` *** ## swaggerhub\_get\_user\_projects Get all projects that a user has access to **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nameOnly": { "type": "boolean", "description": "Return the project information excluding APIs and domains" }, "page": { "type": "integer", "description": "Page to return" }, "limit": { "type": "integer", "description": "Number of results per page (1 .. 100)" }, "sort": { "type": "string", "description": "Sort criteria or result set: * NAME * OWNER", "enum": [ "NAME", "OWNER" ] }, "order": { "type": "string", "description": "Sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID" ] } ``` *** ## swaggerhub\_get\_yaml\_definition Get the OpenAPI definition for the specified API version in YAML format **Parameters:** | Parameter | Type | Required | Default | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "resolved": { "type": "boolean", "description": "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": { "type": "boolean", "description": "If set to `true`, it creates models from inline schemas in OpenAPI definition. AsyncAPI definitions cannot be flattened." } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_patch\_integration Partially update integration settings **Parameters:** | Parameter | Type | Required | Default | 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 | — | An object that contains the integration parameters you want to update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "integrationId": { "type": "string", "description": "Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations`" }, "body": { "type": "object", "description": "An object that contains the integration parameters you want to update" } }, "required": [ "PCID", "owner", "api", "version", "integrationId", "body" ] } ``` *** ## swaggerhub\_rename\_api Rename an API **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `newName` | string | Yes | — | New name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "newName": { "type": "string", "description": "New name" } }, "required": [ "PCID", "owner", "api", "newName" ] } ``` *** ## swaggerhub\_rename\_domain Rename a domain **Parameters:** | Parameter | Type | Required | Default | 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 code 424. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "newName": { "type": "string", "description": "New name" }, "force": { "type": "boolean", "description": "If this domain is referenced from other APIs and domains, this parameter must be true. Otherwise, the request will be rejected with status code 424." } }, "required": [ "PCID", "owner", "domain", "newName" ] } ``` *** ## swaggerhub\_rename\_template Rename a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `newName` | string | Yes | — | New name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "newName": { "type": "string", "description": "New name" } }, "required": [ "PCID", "owner", "templateId", "newName" ] } ``` *** ## swaggerhub\_save\_definition Create or update an API **Parameters:** | Parameter | Type | Required | Default | 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. Either the `version` parameter or the `info.version` value must be specified, otherwise the request will be rejected. If both are specified, the `version` parameter overrides the `info.version` value. If this API version already exists, it will be updated with the new definition (unless that version has been published - in this case the update will be rejected). | | `force` | boolean | No | — | Force update | | `body` | string | Yes | — | OpenAPI definition in the YAML or JSON format. The content must be syntactically valid YAML or JSON. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner name (organization or user name, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "isPrivate": { "type": "boolean", "description": "Whether to make the API private (`true`) or public (`false`)" }, "version": { "type": "string", "description": "API version to create or update. If omitted, the version is extracted from the `info.version` field of the provided OpenAPI definition. Either the `version` parameter or the `info.version` value must be specified, otherwise the request will be rejected. If both are specified, the `version` parameter overrides the `info.version` value. If this API version already exists, it will be updated with the new definition (unless that version has been published - in this case the update will be rejected)." }, "force": { "type": "boolean", "description": "Force update" }, "body": { "type": "string", "description": "OpenAPI definition in the YAML or JSON format. The content must be syntactically valid YAML or JSON." } }, "required": [ "PCID", "owner", "api", "body" ] } ``` *** ## swaggerhub\_save\_domain\_definition Create or update a domain **Parameters:** | Parameter | Type | Required | Default | 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` | string | No | — | OpenAPI definition of this domain | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "isPrivate": { "type": "boolean", "description": "Specifies whether the domain has to be private" }, "version": { "type": "string", "description": "Domain version. If omitted, will be taken from the `info.version` field in the definition." }, "force": { "type": "boolean", "description": "Force update" }, "body": { "type": "string", "description": "OpenAPI definition of this domain" } }, "required": [ "PCID", "owner", "domain" ] } ``` *** ## swaggerhub\_save\_project\_v2 Update a project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `owner` | string | Yes | — | Organization name (case-sensitive) | | `projectId` | string | Yes | — | Project name (case-sensitive) | | `apis` | string\[] | No | — | A list of APIs included in this project. The APIs must belong to the same owner as the project. API names are case-sensitive. | | `description` | string | No | — | Project description | | `domains` | string\[] | No | — | A list of domains included in this project. The domains must belong to the same owner as the project. Domain names are case-sensitive. | | `name` | string | No | — | Project name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "projectId": { "type": "string", "description": "Project name (case-sensitive)" }, "apis": { "type": "array", "items": { "type": "string" }, "description": "A list of APIs included in this project. The APIs must belong to the same owner as the project. API names are case-sensitive." }, "description": { "type": "string", "description": "Project description" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "A list of domains included in this project. The domains must belong to the same owner as the project. Domain names are case-sensitive." }, "name": { "type": "string", "description": "Project name" } }, "required": [ "PCID", "owner", "projectId" ] } ``` *** ## swaggerhub\_save\_template\_definition Create or update a template **Parameters:** | Parameter | Type | Required | Default | 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` | string | Yes | — | The template definition | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "isPrivate": { "type": "boolean", "description": "Defines whether the API or template has to be private" }, "version": { "type": "string", "description": "Template version to create or update. If omitted, the version will be taken from the `info.version` field in the definition." }, "force": { "type": "boolean", "description": "Force update" }, "projectName": { "type": "string", "description": "The project to add the API, domain, or template to" }, "body": { "type": "string", "description": "The template definition" } }, "required": [ "PCID", "owner", "templateId", "body" ] } ``` *** ## swaggerhub\_search\_apis Search APIs **Parameters:** | Parameter | Type | Required | Default | 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 ready for consuming from client applications \* ANY - either PUBLISHED or UNPUBLISHED | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Free text query to match" }, "state": { "type": "string", "description": "Matches against published state of the spec: * UNPUBLISHED - spec is a draft, a work in progress * PUBLISHED - spec is a stable version ready for consuming from client applications * ANY - either PUBLISHED or UNPUBLISHED", "enum": [ "ALL", "PUBLISHED", "UNPUBLISHED" ] }, "page": { "type": "integer", "description": "Page to return" }, "limit": { "type": "integer", "description": "Number of results per page (1 .. 100)" }, "sort": { "type": "string", "description": "Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title`", "enum": [ "NAME", "UPDATED", "CREATED", "OWNER", "BEST_MATCH", "TITLE" ] }, "order": { "type": "string", "description": "Sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID" ] } ``` *** ## swaggerhub\_search\_apis\_and\_domains Retrieve a list of currently defined APIs, domains, and templates in APIs.json format **Parameters:** | Parameter | Type | Required | Default | 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 organization and those that you are collaborating with or have shared it with \* ANY - either PUBLIC or PRIVATE | | `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 ready for consuming from client applications \* ANY - either PUBLISHED or UNPUBLISHED | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "specType": { "type": "string", "description": "Type of definitions to search: * API - APIs only * DOMAIN - domains only * TEMPLATE - templates only * ANY - APIs, domains, and templates", "enum": [ "API", "DOMAIN", "TEMPLATE", "ANY" ] }, "visibility": { "type": "string", "description": "The visibility of a definition in SwaggerHub: * PUBLIC - can be viewed by anyone * PRIVATE - can only be viewed by you or your organization and those that you are collaborating with or have shared it with * ANY - either PUBLIC or PRIVATE", "enum": [ "PUBLIC", "PRIVATE", "ANY" ] }, "state": { "type": "string", "description": "Matches against published state of the spec: * UNPUBLISHED - spec is a draft, a work in progress * PUBLISHED - spec is a stable version ready for consuming from client applications * ANY - either PUBLISHED or UNPUBLISHED", "enum": [ "ALL", "PUBLISHED", "UNPUBLISHED" ] }, "owner": { "type": "string", "description": "API or domain owner. Can be username or organization name. Case-sensitive." }, "query": { "type": "string", "description": "Free text query to match" }, "page": { "type": "integer", "description": "Page to return" }, "limit": { "type": "integer", "description": "Number of results per page (1 .. 100)" }, "sort": { "type": "string", "description": "Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title`", "enum": [ "NAME", "UPDATED", "CREATED", "OWNER", "BEST_MATCH", "TITLE" ] }, "order": { "type": "string", "description": "Sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID" ] } ``` *** ## swaggerhub\_search\_domains Search domains **Parameters:** | Parameter | Type | Required | Default | 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 ready for consuming from client applications \* ANY - either PUBLISHED or UNPUBLISHED | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Free text query to match" }, "state": { "type": "string", "description": "Matches against published state of the spec: * UNPUBLISHED - spec is a draft, a work in progress * PUBLISHED - spec is a stable version ready for consuming from client applications * ANY - either PUBLISHED or UNPUBLISHED", "enum": [ "ALL", "PUBLISHED", "UNPUBLISHED" ] }, "page": { "type": "integer", "description": "Page to return" }, "limit": { "type": "integer", "description": "Number of results per page (1 .. 100)" }, "sort": { "type": "string", "description": "Sort criteria of result set: * NAME * UPDATED * CREATED * OWNER * BEST_MATCH - by relevance * TITLE - by `info.title`", "enum": [ "NAME", "UPDATED", "CREATED", "OWNER", "BEST_MATCH", "TITLE" ] }, "order": { "type": "string", "description": "Sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "PCID" ] } ``` *** ## swaggerhub\_set\_api\_comment\_status\_v2 Resolve or reopen a comment **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "status": { "type": "string", "description": "Comment status", "enum": [ "OPEN", "RESOLVED" ] } }, "required": [ "PCID", "owner", "api", "version", "comment", "status" ] } ``` *** ## swaggerhub\_set\_api\_default\_version Set the default API version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier (case-insensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier (case-insensitive)" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_set\_domain\_comment\_status\_v2 Resolve or reopen a comment **Parameters:** | Parameter | Type | Required | Default | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "status": { "type": "string", "description": "Comment status", "enum": [ "OPEN", "RESOLVED" ] } }, "required": [ "PCID", "owner", "domain", "version", "comment", "status" ] } ``` *** ## swaggerhub\_set\_domain\_default\_version Set the default version for a domain **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier (case-insensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier (case-insensitive)" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_set\_domain\_lifecycle\_settings Publish or unpublish a domain version **Parameters:** | Parameter | Type | Required | Default | 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 with status code 424. | | `published` | boolean | No | — | Whether the definition is published (`true`) or unpublished (`false`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "force": { "type": "boolean", "description": "To publish a domain that references other _unpublished_ domains, this parameter must be `true`. Otherwise, the request will be rejected with status code 424." }, "published": { "type": "boolean", "description": "Whether the definition is published (`true`) or unpublished (`false`)" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_set\_domain\_private\_settings Set the visibility (public or private) of a domain version **Parameters:** | Parameter | Type | Required | Default | 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 be `true`. Otherwise, the request will be rejected with status code 424. | | `private` | boolean | Yes | — | Whether the definition version is private (`true`) or public (`false`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "force": { "type": "boolean", "description": "To change the visibility from _public_ to _private_ in case this domain is referenced from other _public_ definitions, this parameter must be `true`. Otherwise, the request will be rejected with status code 424." }, "private": { "type": "boolean", "description": "Whether the definition version is private (`true`) or public (`false`)" } }, "required": [ "PCID", "owner", "domain", "version", "private" ] } ``` *** ## swaggerhub\_set\_lifecycle\_settings Publish or unpublish an API version **Parameters:** | Parameter | Type | Required | Default | 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 status code 424. | | `published` | boolean | No | — | Whether the definition is published (`true`) or unpublished (`false`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "force": { "type": "boolean", "description": "To publish an API that references _unpublished_ domains, this parameter must be `true`. Otherwise, the request will be rejected with status code 424." }, "published": { "type": "boolean", "description": "Whether the definition is published (`true`) or unpublished (`false`)" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_set\_private\_settings Set the visibility (public or private) of an API version **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------------------------------------------- | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | | `private` | boolean | Yes | — | Whether the definition version is private (`true`) or public (`false`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "private": { "type": "boolean", "description": "Whether the definition version is private (`true`) or public (`false`)" } }, "required": [ "PCID", "owner", "api", "version", "private" ] } ``` *** ## swaggerhub\_set\_template\_lifecycle\_settings Update lifecycle settings for a template **Parameters:** | Parameter | Type | Required | Default | 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 | | `published` | boolean | No | — | Whether the definition is published (`true`) or unpublished (`false`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" }, "force": { "type": "boolean", "description": "Force update" }, "published": { "type": "boolean", "description": "Whether the definition is published (`true`) or unpublished (`false`)" } }, "required": [ "PCID", "owner", "templateId", "version" ] } ``` *** ## swaggerhub\_set\_template\_private\_settings Update visibility settings for a template **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ---------------------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `version` | string | Yes | — | Version identifier | | `private` | boolean | Yes | — | Whether the definition version is private (`true`) or public (`false`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" }, "private": { "type": "boolean", "description": "Whether the definition version is private (`true`) or public (`false`)" } }, "required": [ "PCID", "owner", "templateId", "version", "private" ] } ``` *** ## swaggerhub\_update\_api\_comment\_reply\_v2 Update a comment reply **Parameters:** | Parameter | Type | Required | Default | 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` | string | No | — | The body value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "reply": { "type": "string", "description": "Reply identifier" }, "body": { "type": "string", "description": "The body value" } }, "required": [ "PCID", "owner", "api", "version", "comment", "reply" ] } ``` *** ## swaggerhub\_update\_api\_comment\_v2 Update a comment **Parameters:** | Parameter | Type | Required | Default | 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` | string | No | — | The body value | | `position` | integer | No | — | The position value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "body": { "type": "string", "description": "The body value" }, "position": { "type": "integer", "description": "The position value" } }, "required": [ "PCID", "owner", "api", "version", "comment" ] } ``` *** ## swaggerhub\_update\_api\_comments\_v2 Bulk update comments **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ------------------------------------------------ | | `owner` | string | Yes | — | API owner (organization or user, case-sensitive) | | `api` | string | Yes | — | API name (case-sensitive) | | `version` | string | Yes | — | Version identifier | | `addComment` | object\[] | No | — | Add Comment | | `addReply` | object | No | — | Add Reply | | `deleteComment` | string\[] | No | — | Delete Comment | | `deleteReply` | object | No | — | Delete Reply | | `updateComment` | object | No | — | Update Comment | | `updateReply` | object | No | — | Update Reply | | `updateStatus` | object | No | — | Update Status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "addComment": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value" }, "position": { "type": "integer", "format": "int32", "description": "The position value" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string" } } }, "description": "The replies value" } }, "required": [ "position", "body" ] }, "description": "Add Comment" }, "addReply": { "type": "object", "description": "Add Reply" }, "deleteComment": { "type": "array", "items": { "type": "string" }, "description": "Delete Comment" }, "deleteReply": { "type": "object", "description": "Delete Reply" }, "updateComment": { "type": "object", "description": "Update Comment" }, "updateReply": { "type": "object", "description": "Update Reply" }, "updateStatus": { "type": "object", "description": "Update Status" } }, "required": [ "PCID", "owner", "api", "version" ] } ``` *** ## swaggerhub\_update\_domain\_comment\_reply\_v2 Update a comment reply **Parameters:** | Parameter | Type | Required | Default | 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` | string | No | — | The body value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "reply": { "type": "string", "description": "Reply identifier" }, "body": { "type": "string", "description": "The body value" } }, "required": [ "PCID", "owner", "domain", "version", "comment", "reply" ] } ``` *** ## swaggerhub\_update\_domain\_comment\_v2 Update a comment **Parameters:** | Parameter | Type | Required | Default | 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` | string | No | — | The body value | | `position` | integer | No | — | The position value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "comment": { "type": "string", "description": "Comment identifier" }, "body": { "type": "string", "description": "The body value" }, "position": { "type": "integer", "description": "The position value" } }, "required": [ "PCID", "owner", "domain", "version", "comment" ] } ``` *** ## swaggerhub\_update\_domain\_comments\_v2 Bulk update comments **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | --------------------------------------------------- | | `owner` | string | Yes | — | Domain owner (organization or user, case-sensitive) | | `domain` | string | Yes | — | Domain name (case-sensitive) | | `version` | string | Yes | — | Version identifier | | `addComment` | object\[] | No | — | Add Comment | | `addReply` | object | No | — | Add Reply | | `deleteComment` | string\[] | No | — | Delete Comment | | `deleteReply` | object | No | — | Delete Reply | | `updateComment` | object | No | — | Update Comment | | `updateReply` | object | No | — | Update Reply | | `updateStatus` | object | No | — | Update Status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Domain owner (organization or user, case-sensitive)" }, "domain": { "type": "string", "description": "Domain name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "addComment": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value" }, "position": { "type": "integer", "format": "int32", "description": "The position value" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string" } } }, "description": "The replies value" } }, "required": [ "position", "body" ] }, "description": "Add Comment" }, "addReply": { "type": "object", "description": "Add Reply" }, "deleteComment": { "type": "array", "items": { "type": "string" }, "description": "Delete Comment" }, "deleteReply": { "type": "object", "description": "Delete Reply" }, "updateComment": { "type": "object", "description": "Update Comment" }, "updateReply": { "type": "object", "description": "Update Reply" }, "updateStatus": { "type": "object", "description": "Update Status" } }, "required": [ "PCID", "owner", "domain", "version" ] } ``` *** ## swaggerhub\_update\_integration Update integration settings **Parameters:** | Parameter | Type | Required | Default | 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 | — | Can be one of the following objects: \| `configType` value \| Object \| \| ------------------------- \| ------ \| \| AMAZON\_API\_GATEWAY \| AmazonApiGatewayIntegration \| \| AMAZON\_API\_GATEWAY\_LAMBDA \| AmazonApiGatewayLambdaIntegration \| \| API\_AUTO\_MOCKING \| AutoMockingIntegration \| \| APIGEE\_EDGE \| ApigeeEdgeIntegration \| \| AZURE\_API\_MANAGEMENT \| AzureApiManagementIntegration \| \| AZURE\_DEVOPS\_SERVICES \| AzureDevopsServicesIntegration \| \| BITBUCKET\_CLOUD \| BitbucketCloudIntegration \| \| BITBUCKET\_SERVER \| BitbucketServerIntegration \| \| GITHUB \| GitHubIntegration \| \| GITHUB\_ENTERPRISE \| GitHubEnterpriseIntegration \| \| GITLAB \| GitLabIntegration \| \| IBM\_API\_CONNECT \| IBMApiConnectIntegration \| \| WEBHOOK \| WebhookIntegration \| For more examples, see the JSON files in this repository: [https://github.com/SmartBear/swaggerhub-cli/tree/master/examples/integrations](https://github.com/SmartBear/swaggerhub-cli/tree/master/examples/integrations) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API owner (organization or user, case-sensitive)" }, "api": { "type": "string", "description": "API name (case-sensitive)" }, "version": { "type": "string", "description": "Version identifier" }, "integrationId": { "type": "string", "description": "Integration ID (case-sensitive). To get the available integration IDs, use `GET /apis/{owner}/{api}/{version}/integrations`" }, "body": { "type": "object", "description": "Can be one of the following objects: | `configType` value | Object | | ------------------------- | ------ | | AMAZON_API_GATEWAY | AmazonApiGatewayIntegration | | AMAZON_API_GATEWAY_LAMBDA | AmazonApiGatewayLambdaIntegration | | API_AUTO_MOCKING | AutoMockingIntegration | | APIGEE_EDGE | ApigeeEdgeIntegration | | AZURE_API_MANAGEMENT | AzureApiManagementIntegration | | AZURE_DEVOPS_SERVICES | AzureDevopsServicesIntegration | | BITBUCKET_CLOUD | BitbucketCloudIntegration | | BITBUCKET_SERVER | BitbucketServerIntegration | | GITHUB | GitHubIntegration | | GITHUB_ENTERPRISE | GitHubEnterpriseIntegration | | GITLAB | GitLabIntegration | | IBM_API_CONNECT | IBMApiConnectIntegration | | WEBHOOK | WebhookIntegration | For more examples, see the JSON files in this repository: https://github.com/SmartBear/swaggerhub-cli/tree/master/examples/integrations" } }, "required": [ "PCID", "owner", "api", "version", "integrationId", "body" ] } ``` *** ## swaggerhub\_update\_project\_members\_v2 Update a project's members list **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ---------------------------------- | | `owner` | string | Yes | — | Organization name (case-sensitive) | | `projectId` | string | Yes | — | Project name (case-sensitive) | | `members` | object\[] | No | — | The members value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "Organization name (case-sensitive)" }, "projectId": { "type": "string", "description": "Project name (case-sensitive)" }, "members": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name value" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "The roles value" }, "type": { "type": "string", "enum": [ "USER", "TEAM" ], "description": "The type value" } }, "required": [ "name", "type" ] }, "description": "The members value" } }, "required": [ "PCID", "owner", "projectId" ] } ``` *** ## swaggerhub\_update\_template\_comments Update the list of comments for a template **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ---------------------------------------------------------- | | `owner` | string | Yes | — | API, domain, or template owner identifier (case-sensitive) | | `templateId` | string | Yes | — | Template identifier | | `version` | string | Yes | — | Version identifier | | `addComment` | object\[] | No | — | Add Comment | | `addReply` | object | No | — | Add Reply | | `deleteComment` | string\[] | No | — | Delete Comment | | `deleteReply` | object | No | — | Delete Reply | | `updateComment` | object | No | — | Update Comment | | `updateReply` | object | No | — | Update Reply | | `updateStatus` | object | No | — | Update Status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner": { "type": "string", "description": "API, domain, or template owner identifier (case-sensitive)" }, "templateId": { "type": "string", "description": "Template identifier" }, "version": { "type": "string", "description": "Version identifier" }, "addComment": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string", "description": "The body value" }, "position": { "type": "integer", "format": "int32", "description": "The position value" }, "replies": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string" } } }, "description": "The replies value" } }, "required": [ "position", "body" ] }, "description": "Add Comment" }, "addReply": { "type": "object", "description": "Add Reply" }, "deleteComment": { "type": "array", "items": { "type": "string" }, "description": "Delete Comment" }, "deleteReply": { "type": "object", "description": "Delete Reply" }, "updateComment": { "type": "object", "description": "Update Comment" }, "updateReply": { "type": "object", "description": "Update Reply" }, "updateStatus": { "type": "object", "description": "Update Status" } }, "required": [ "PCID", "owner", "templateId", "version" ] } ```