Home

Swaggerhub (version v3.*.*)

delete_api#

Deletes the specified API

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

delete_collaboration#

Deletes API's collaboration

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

delete_domain#

Deletes the specified domain

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

force#

Force update

Type: boolean

delete_version_for_api#

Deletes a particular version of the specified API

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

delete_version_for_domain#

Deletes a particular version of the specified domain

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

force#

Force update

Type: boolean

get_collaboration#

Gets API's collaboration

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

expandTeams#

Type: boolean

get_comments_for_api#

Returns all the comments and replies added by collaborators in the specified API version.

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

get_comments_for_domain#

Returns all the comments and replies added by collaborators in the specified domain version.

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

get_definition#

Retrieves the Swagger definition for the specified API and version

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

get_definition_for_domain#

Retrieves the Swagger definition for the specified domain and version

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

get_json_definition#

Retrieves the Swagger definition for the specified API and version in JSON format

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

get_json_for_domain#

Retrieves the definition for the specified domain and version in JSON format

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

get_yaml_definition#

Retrieves the Swagger definition for the specified API and version in YAML format

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

get_yaml_for_domain#

Retrieves the definition for the specified domain and version in YAML format

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

version (required)#

Version identifier (case-sensitive)

Type: string

list_apis_for_owner#

Retrieves an APIs.json listing of all APIs defined for this owner

Parameters

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

order#

Sort order

Type: string

Potential values: ASC, DESC

sort#

Sort criteria or result set:

  • NAME
  • UPATED
  • CREATED
  • OWNER

Type: string

Potential values: NAME, UPDATED, CREATED, OWNER

list_domains_for_owner#

Retrieves an APIs.json listing of all domains defined for this owner

Parameters

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

order#

Sort order

Type: string

Potential values: ASC, DESC

sort#

Sort criteria or result set:

  • NAME
  • UPATED
  • CREATED
  • OWNER

Type: string

Potential values: NAME, UPDATED, CREATED, OWNER

list_versions_for_api#

Retrieves an APIs.json listing for all API versions for this owner and API

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

list_versions_for_domain#

Retrieves an APIs.json listing for all domain versions for this owner and domain

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

save_definition#

Saves the provided Swagger definition; the owner must match the token owner. The version will be extracted from the Swagger definition itself.

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

$body#

The Swagger definition of this API

Type: string

force#

Force update

Type: boolean

isPrivate#

Defines whether the API has to be private

Type: boolean

version#

API version

Type: string

save_definition_for_domain#

Saves the provided Swagger definition of a domain

Parameters

domain (required)#

Domain name (case-sensitive)

Type: string

owner (required)#

Domain owner (user or organization, case-sensitive)

Type: string

version (required)#

Domain version

Type: string

$body#

The Swagger definition of this domain

Type: string

force#

Force update

Type: boolean

isPrivate#

Specifies whether the domain has to be private

Type: boolean

search_apis#

Retrieves a list of currently defined APIs in APIs.json format.

Parameters

order#

Sort order

Type: string

Potential values: ASC, DESC

query#

Free text query to match

Type: string

sort#

Sort criteria or result set:

  • NAME
  • UPATED
  • CREATED
  • OWNER

Type: string

Potential values: NAME, UPDATED, CREATED, OWNER

state#

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

Type: string

Potential values: ALL, PUBLISHED, UNPUBLISHED

tag#

Matches against tags associated with an API

Type: array

[ "string" ]

search_apis_and_domains#

Retrieves a list of currently defined APIs and Domains in APIs.json format

Parameters

order#

Sort order

Type: string

Potential values: ASC, DESC

owner#

API or Domain owner identifier. Can be username or organization name

Type: string

query#

Free text query to match

Type: string

sort#

Sort criteria or result set:

  • NAME
  • UPATED
  • CREATED
  • OWNER

Type: string

Potential values: NAME, UPDATED, CREATED, OWNER

specType#

Type of Swagger specs to search:

  • API - APIs only
  • DOMAIN - Domains only
  • ANY - Both APIs and Domains

Type: string

Potential values: API, DOMAIN, ANY

state#

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

Type: string

Potential values: ALL, PUBLISHED, UNPUBLISHED

visibility#

The visibility of a spec in SwaggerHub:

  • PUBLIC - can be viewed by anyone
  • PRIVATE - can only be viewed by you or your Org and those that you are collaborating with or have shared it with
  • ANY - either PUBLIC or PRIVATE

Type: string

Potential values: PUBLIC, PRIVATE, ANY

search_domains#

Retrieves a list of currently defined domains in APIs.json format

Parameters

order#

Sort order

Type: string

Potential values: ASC, DESC

query#

Free text query to match

Type: string

sort#

Sort criteria or result set:

  • NAME
  • UPATED
  • CREATED
  • OWNER

Type: string

Potential values: NAME, UPDATED, CREATED, OWNER

state#

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

Type: string

Potential values: ALL, PUBLISHED, UNPUBLISHED

tag#

Matches against tags associated with a domain

Type: array

[ "string" ]

update_collaboration#

Updates API's collaboration

Parameters

api (required)#

API name (case-sensitive)

Type: string

owner (required)#

API owner (user or organization, case-sensitive)

Type: string

$body#

Type: object

{
  "owner" : "string",
  "teams" : [ {
    "name" : "Required string",
    "startTime" : "date-time",
    "title" : "string",
    "uuid" : "string",
    "blocked" : "boolean",
    "roles" : [ "string. Possible values: EDIT | COMMENT | VIEW" ],
    "donotdisturb" : "boolean",
    "members" : [ {
      "name" : "Required string",
      "startTime" : "date-time",
      "title" : "string",
      "uuid" : "string"
    } ]
  } ],
  "hint" : {
    "type" : "type identifier of the managed entity"
  },
  "members" : [ {
    "name" : "Required string",
    "startTime" : "date-time",
    "title" : "string",
    "uuid" : "string",
    "blocked" : "boolean",
    "roles" : [ "string. Possible values: EDIT | COMMENT | VIEW" ],
    "donotdisturb" : "boolean"
  } ],
  "owners" : [ "string" ],
  "pendingMembers" : [ {
    "name" : "Required string",
    "startTime" : "date-time",
    "title" : "string",
    "uuid" : "string",
    "blocked" : "boolean",
    "roles" : [ "string. Possible values: EDIT | COMMENT | VIEW" ],
    "donotdisturb" : "boolean"
  } ]
}