/api/contents

Back to index

GETlistContents

Summary

List contents

if-modified-since
Stringoptional
q
Stringrequired
The query string
data
Booleanoptional
Return the data inline (note: consumes additional API credits)
componentGroup
Stringoptional
Only return data for this particular component group
limit
Integeroptional
The maximum number of results to return

Response

200 - OK
Content-Type: application/json, payload type: ListContentsResponse

Example

Request
$ BASE_URL="https://docs.cloudbees.com"
$ TOKEN="xxx"
$ curl "Authorization: Bearer ${TOKEN}" \
       "${BASE_URL}/api/contents?q=How%20do%20I%20install%20Jenkins&component-group=cloudbees-ci" \
       -H 'Content-Type: application/json'
▼
Response
{
  "count": 1,
  "results": [
    {
      "href": "/api/contents/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "similarity": 0.31,
      "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "path": "/docs/cloudbees-ci/latest/client-and-managed-controllers/signature-verification-failed-update-center",
      "type": "page",
      "version": "latest",
      "title": "CloudBees CI - Installation",
      "lastModified": "2023-10-04T00:40:36.293Z"
    }
  ]
}
▼