Search APIs and domains
GET {{baseUrl}}/specs?specType=ANY&visibility=ANY&state=ALL&owner=adipisicing aliquip in tempor&query=adipisicing aliquip in tempor&page=0&limit=10&sort=NAME&order=ASC
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
specType | string | Type of definitions to search: |
- API - APIs only
- DOMAIN - Domains only
- ANY - Both APIs and domains
|
|
visibility
| string | | 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 | | 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 | | API or domain owner. Can be username or organization name. Case-sensitive. | |query
| string | | Free text query to match | |page
| number | | Page to return | |limit
| number | | Number of results per page (1 .. 100) | |sort
| string | | Sort criteria of result set: - NAME
- UPDATED
- CREATED
- OWNER
- BEST_MATCH - by relevance
- TITLE - by
info.title
| |order
| string | | Sort order |
RESPONSES
status: OK
{"name":"Default listing","description":"Default registry listing","url":"voluptate enim aute","offset":83106172,"totalCount":1,"apis":[{"name":"petstore","description":"This is a sample Petstore server.","tags":["moll","in dolore cupidatat"],"properties":[{"type":"Swagger","url":"https://api.swaggerhub.com/apis/username/petstore/1.1"},{"type":"X-Version","value":"1.1"},{"type":"X-Created","value":"2017-01-16T13:39:06Z"},{"type":"X-Modified","value":"2017-01-25T11:48:13Z"},{"type":"X-Published","value":"true"},{"type":"X-Versions","value":"1.0,*1.1,1.1-oas3"},{"type":"X-Private","value":"false"},{"type":"X-OASVersion","value":"3.0.0"},{"type":"X-Notifications","value":"true"},{"type":"X-CreatedBy","value":"username"}]},{"name":"petstore","description":"This is a sample Petstore server.","tags":["aliqua","incididunt ea ut"],"properties":[{"type":"Swagger","url":"https://api.swaggerhub.com/apis/username/petstore/1.1"},{"type":"X-Version","value":"1.1"},{"type":"X-Created","value":"2017-01-16T13:39:06Z"},{"type":"X-Modified","value":"2017-01-25T11:48:13Z"},{"type":"X-Published","value":"true"},{"type":"X-Versions","value":"1.0,*1.1,1.1-oas3"},{"type":"X-Private","value":"false"},{"type":"X-OASVersion","value":"3.0.0"},{"type":"X-Notifications","value":"true"},{"type":"X-CreatedBy","value":"username"}]}]}