API 1.1.0

API to manage your DeveloperHub resources programmatically. Using these APIs, you are able to manage pages, integrate with CI/CD, and retrieve resources among other operations.

Server

https://api.developerhub.io/api/v1

Authentication

apiKey Api-Key

Generate an API Key from DeveloperHub.io platform and provide it in the header such as --header "X-Api-Key: <api-key>" for cURL for all the requests requiring this authentication.

Fields

Key	In
X-Api-Key	Header

Page

Operations for creating, reading, updating, publishing, and deleting pages.

/documentation/{id}/page

PUT

/page/{id}/publish

Get page by slug

Get a page by slugs and read its content in Markdoc or a derived format. Rate limit: 60 in 1 minute.

Either version_id or version_slug must be provided. Either documentation_id or documentation_slug must be provided.

Auth

Query String

version_id	integer	Version ID.
version_slug	string	Version Slug.
documentation_id	integer	Documentation ID.
documentation_slug	string	Documentation Slug.
page_slug	string	Page Slug.
format	string	Format type Enum: `markdoc`,`markdown`,`html`,`text` Default: markdoc

GET /page

 
curl --get \ --url 'https://api.developerhub.io/api/v1/page' \ --header 'X-Api-Key: {X-Api-Key}' \ --data version_id={version_id} \ --data version_slug={version_slug} \ --data documentation_id={documentation_id} \ --data documentation_slug={documentation_slug} \ --data page_slug={page_slug} \ --data format=markdoc
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Page	object	Page object
id	integer	Unique identifier
listed	boolean	True if it can be viewed by readers if the version is published
title	string	Title of the page
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
path	string	Path of the page as version, documentation and page slugs
contentDraft	string?	Draft content in the selected format. Null if the page has no draft
contentPublished	string?	Published content in the selected format. Null if never published

403

Access denied

429

Too many requests

Response

 
{ "id": 86123, "listed": true, "title": "Getting Started", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "getting-started", "path": "v1.0/support-center/getting-started", "contentDraft": "This is the page contents", "contentPublished": "This is the page contents"}
Copy

Read page

Read a page including its content in Markdoc or a derived format. Rate limit: 600 in 1 minute.

Auth

Path Params

integer

Page ID

Query String

format

string

Format type

Enum: markdoc,markdown,html,text

Default: markdoc

GET /page/{id}

 
curl --get \ --url 'https://api.developerhub.io/api/v1/page/{id}' \ --header 'X-Api-Key: {X-Api-Key}' \ --data format=markdoc
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Page	object	Page object
id	integer	Unique identifier
listed	boolean	True if it can be viewed by readers if the version is published
title	string	Title of the page
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
path	string	Path of the page as version, documentation and page slugs
contentDraft	string?	Draft content in the selected format. Null if the page has no draft
contentPublished	string?	Published content in the selected format. Null if never published

403

Access denied

429

Too many requests

Response

 
{ "id": 86123, "listed": true, "title": "Getting Started", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "getting-started", "path": "v1.0/support-center/getting-started", "contentDraft": "This is the page contents", "contentPublished": "This is the page contents"}
Copy

Update a page

Updates a page title, slug or draft contents. Rate limit: 10800 in 1 hour.

Auth

Path Params

integer

Page ID

Request Body

object	object	Page object
title	string	Title of the page
slug	string	Slug in the URL. Generated if it was not provided
content	string	Draft contents of the page in Markdoc format
message	string	Page history message Default: Updated using API

PUT /page/{id}

 
curl --request PUT \ --url 'https://api.developerhub.io/api/v1/page/{id}' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "title": "Getting Started",  "slug": "getting-started",  "content": "Let's start here\n\n## Step 1\nWelcome to **DeveloperHub**\n\n{% callout type=\"info\" title=\"Note\" %}\nContent is written in Markdoc.\n{% /callout %}\n",  "message": "{string}"}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Page	object	Page object
id	integer	Unique identifier
listed	boolean	True if it can be viewed by readers if the version is published
title	string	Title of the page
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
path	string	Path of the page as version, documentation and page slugs
contentDraft	string?	Draft content in the selected format. Null if the page has no draft
contentPublished	string?	Published content in the selected format. Null if never published

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

 
{ "id": 86123, "listed": true, "title": "Getting Started", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "getting-started", "path": "v1.0/support-center/getting-started", "contentDraft": "This is the page contents", "contentPublished": "This is the page contents"}
Copy

Delete a page

Deletes a page and removes it from the navigation index. Rate limit: 10800 in 1 hour.

Auth

Path Params

integer

Page ID

DELETE /page/{id}

 
curl --request DELETE \ --url 'https://api.developerhub.io/api/v1/page/{id}' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
object	object	Empty object

403

Access denied

429

Too many requests

Response

 
{}
Copy

Create a page

Creates a page with draft contents. To insert in a pre-existing category, set the categoryTitle. Rate limit: 10800 in 1 hour.

Auth

Path Params

integer

Documentation ID

Request Body

object	object	Page object
title	string	Title of the page
slug	string	Slug in the URL. Generated if it was not provided
content	string	Draft contents of the page in Markdoc format
categoryTitle	string	To create the page inside a category, provide the pre-existing category title here (case insensitive). The page is added after the category's existing pages.
message	string	Page history message Default: Created using API

POST /documentation/{id}/page

 
curl --request POST \ --url 'https://api.developerhub.io/api/v1/documentation/{id}/page' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "title": "Getting Started",  "slug": "getting-started",  "content": "Let's start here\n\n## Step 1\nWelcome to **DeveloperHub**\n\n{% callout type=\"info\" title=\"Note\" %}\nContent is written in Markdoc.\n{% /callout %}\n",  "categoryTitle": "Installation",  "message": "{string}"}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Page	object	Page object
id	integer	Unique identifier
listed	boolean	True if it can be viewed by readers if the version is published
title	string	Title of the page
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
path	string	Path of the page as version, documentation and page slugs
contentDraft	string?	Draft content in the selected format. Null if the page has no draft
contentPublished	string?	Published content in the selected format. Null if never published

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

 
{ "id": 86123, "listed": true, "title": "Getting Started", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "getting-started", "path": "v1.0/support-center/getting-started", "contentDraft": "This is the page contents", "contentPublished": "This is the page contents"}
Copy

Publish a page

Publishes a page from its draft contents. Rate limit: 10800 in 1 hour.

Auth

Path Params

integer

Page ID

PUT /page/{id}/publish

 
curl --request PUT \ --url 'https://api.developerhub.io/api/v1/page/{id}/publish' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Page	object	Page object
id	integer	Unique identifier
listed	boolean	True if it can be viewed by readers if the version is published
title	string	Title of the page
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
path	string	Path of the page as version, documentation and page slugs
contentDraft	string?	Draft content in the selected format. Null if the page has no draft
contentPublished	string?	Published content in the selected format. Null if never published

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

 
{ "id": 86123, "listed": true, "title": "Getting Started", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "getting-started", "path": "v1.0/support-center/getting-started", "contentDraft": "This is the page contents", "contentPublished": "This is the page contents"}
Copy

Documentation

Operations for listing documentation sections.

GET

/version/{id}/documentation

Lists documentation sections in a version

Lists all documentation sections in a version. Rate limit: 60 in 60 minutes.

Auth

Path Params

integer

Version ID

GET /version/{id}/documentation

 
curl --get \ --url 'https://api.developerhub.io/api/v1/version/{id}/documentation' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Documentation	array[object]	OK
id	integer	Unique identifier
title	string	Title of the documentation section
slug	string	Slug in the URL
description	string?	Description of the documentation section
created	string	Date of creation
updated	string	Date of last update
pagesUpdated	string?	Date of last update to any page in the section
ordr	integer	Numerical order in the version
published	boolean	True if it can be viewed by readers
collapsed	boolean	True if the section's navigation starts collapsed
wide	boolean	True if pages render in wide layout
sticky	boolean	True if the section navigation is sticky
locale	string	Locale of the section
showPagesLastUpdated	boolean	True if pages show their last update date
showPagesLastUpdateUser	boolean	True if pages show who last updated them
hasExpandableCategories	boolean	True if navigation categories are expandable

403

Access denied

429

Too many requests

Response

 
[ {  "id": 412,  "title": "Support Center",  "slug": "support-center",  "description": "Guides and troubleshooting",  "created": "2019-03-20T19:02:14+0000",  "updated": "2019-03-20T19:02:14+0000",  "pagesUpdated": "2019-03-20T19:02:14+0000",  "ordr": 1,  "published": true,  "collapsed": true,  "wide": true,  "sticky": true,  "locale": "en_us",  "showPagesLastUpdated": false,  "showPagesLastUpdateUser": false,  "hasExpandableCategories": false }]
Copy

Version

Operations for listing, updating, and reporting on project versions.

Lists all project versions

Lists all project versions that are accessible through the API Key. This will only list non-deleted versions. Rate limit: 60 in 60 minutes.

Auth

GET /version

 
curl --get \ --url 'https://api.developerhub.io/api/v1/version' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Version	array[object]	OK
id	integer	Unique identifier
published	boolean	True if it can be viewed by readers
name	string	Name of the version
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
ordr	integer	Numerical order in the project

403

Access denied

429

Too many requests

Response

 
[ {  "id": 4,  "published": true,  "name": "v1.0",  "created": "2019-03-20T19:02:14+0000",  "updated": "2019-03-20T19:02:14+0000",  "slug": "developerhub.io-api",  "ordr": 4 }]
Copy

Update a version

Updates a version. Enables you to publish or unpublish a version. Rate limit: 3600 in 1 hour.

Auth

Path Params

integer

Version ID

Request Body

object	object	Version object
name	string	Name of the version
slug	string	Slug in the URL
published	boolean	True if it can be viewed by readers

PUT /version/{id}

 
curl --request PUT \ --url 'https://api.developerhub.io/api/v1/version/{id}' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "name": "v1.0",  "slug": "v1.0",  "published": true}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Version	object	Version object
id	integer	Unique identifier
published	boolean	True if it can be viewed by readers
name	string	Name of the version
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
ordr	integer	Numerical order in the project

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

 
{ "id": 4, "published": true, "name": "v1.0", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "developerhub.io-api", "ordr": 4}
Copy

Get version content report

Reports every page in the version with its creation and last-update details. Rate limit: 60 in 60 minutes.

Auth

Path Params

integer

Version ID

Query String

created_by_email

string

Only include pages created by the user with this email address

GET /version/{id}/report

 
curl --get \ --url 'https://api.developerhub.io/api/v1/version/{id}/report' \ --header 'X-Api-Key: {X-Api-Key}' \ --data created_by_email={created_by_email}
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Version Report Page	array[object]	OK
id	integer	Page ID
title	string	Title of the page
hasDraft	boolean	True if the page has unpublished draft changes
listed	boolean	True if the page is accessible for readers
sourceCreated	string	Date the page was originally created, tracked through version duplication to the original page
sourceCreatedBy	object	User attribution in a version report
id	integer?	User ID. Null if unknown
email	string?	User e-mail address. Null if unknown
name	string?	User name. Null if unknown
created	string	Date of creation in this version
createdBy	object	User attribution in a version report
id	integer?	User ID. Null if unknown
email	string?	User e-mail address. Null if unknown
name	string?	User name. Null if unknown
updated	string	Date of last update
updatedBy	object	User attribution in a version report
id	integer?	User ID. Null if unknown
email	string?	User e-mail address. Null if unknown
name	string?	User name. Null if unknown

403

Access denied

429

Too many requests

Response

 
[ {  "id": 86123,  "title": "Getting Started",  "hasDraft": false,  "listed": true,  "sourceCreated": "2019-03-20T19:02:14+0000",  "sourceCreatedBy": {   "id": 3609,   "email": "peter@example.com",   "name": "Peter Griffin"  },  "created": "2019-03-20T19:02:14+0000",  "createdBy": {   "id": 3609,   "email": "peter@example.com",   "name": "Peter Griffin"  },  "updated": "2019-03-20T19:02:14+0000",  "updatedBy": {   "id": 3609,   "email": "peter@example.com",   "name": "Peter Griffin"  } }]
Copy

Reference

Operations for adding, reading, and publishing API reference specifications.

POST

/version/{versionId}/reference

GET

/reference/{id}/definition

PUT

/reference/{id}/publish

Adds or updates a reference specification

Adds or updates a reference specification in that version. If the reference title matches one that already existed, then it is updated. Rate limit: 300 in 60 minutes.

Auth

Path Params

versionId

string

The version ID

Query String

publish	boolean	Publish the specification immediately. Set to false to import it as a draft to be published later. Default: true
show_try_it_out	boolean	Enable the Try It Out console on the reference
allow_download	boolean	Allow readers to download the specification
expandable	boolean	Show the reference operations as expandable rows

Request Body

object	object
file	file	The API specification in OpenAPI 2/3 (Swagger) format

POST /version/{versionId}/reference

 
curl --request POST \ --url 'https://api.developerhub.io/api/v1/version/{versionId}/reference' \ --header 'Content-Type: multipart/form-data' \ --header 'X-Api-Key: {X-Api-Key}' \ --data publish=true \ --data show_try_it_out={show_try_it_out} \ --data allow_download={allow_download} \ --data expandable={expandable} \ --form 'file=@{file}'
Copy

Responses

201

Created

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Reference	object	Reference object
id	integer	Unique identifier
title	string	Title of the API Reference
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
ordr	integer	Numerical order in the version

400

General Exception

403

Access denied

429

Too many requests

Response

 
{ "id": 5, "title": "DeveloperHub.io API", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "developerhub.io-api", "ordr": 1}
Copy

Read a reference specification

Downloads the raw specification of an API reference in JSON or YAML. Rate limit: 600 in 1 minute.

Auth

Path Params

integer

Reference ID

Query String

draft

boolean

Read the draft specification instead of the published one

Default: false

format

string

Format of the returned specification. auto returns it as originally uploaded; json and yaml convert it if needed.

Enum: auto,json,yaml

Default: auto

GET /reference/{id}/definition

 
curl --get \ --url 'https://api.developerhub.io/api/v1/reference/{id}/definition' \ --header 'X-Api-Key: {X-Api-Key}' \ --data draft={draft} \ --data format=auto
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
object	object	The specification as a JSON document

403

Access denied

404

Draft not found

429

Too many requests

Response

 
{}
Copy

Publish a reference draft

Publishes the draft specification of an API reference. Fails if the reference has no draft. Rate limit: 300 in 60 minutes.

Auth

Path Params

integer

Reference ID

PUT /reference/{id}/publish

 
curl --request PUT \ --url 'https://api.developerhub.io/api/v1/reference/{id}/publish' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

201

Published

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Reference	object	Reference object
id	integer	Unique identifier
title	string	Title of the API Reference
created	string	Date of creation
updated	string	Date of last update
slug	string	Slug in the URL
ordr	integer	Numerical order in the version

400

General Exception

403

Access denied

429

Too many requests

Response

 
{ "id": 5, "title": "DeveloperHub.io API", "created": "2019-03-20T19:02:14+0000", "updated": "2019-03-20T19:02:14+0000", "slug": "developerhub.io-api", "ordr": 1}
Copy

Project

Project-level operations such as export, search, audit log, and users.

Exports project

Exports the project into a ZIP file of Markdoc or Markdown files. Only available for enterprise plans. Rate limit: 10 in 60 minutes.

Auth

Query String

format

string

Format of the exported page files.

Enum: markdoc,markdown

Default: markdoc

version_slug

string

Export only the version with this slug. Omit to export all versions.

GET /export

 
curl --get \ --url 'https://api.developerhub.io/api/v1/export' \ --header 'X-Api-Key: {X-Api-Key}' \ --data format=markdoc \ --data version_slug={version_slug}
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
file	file	OK

400

Upgrade Plan

403

Access denied

429

Too many requests

Response

 
Zip file
Copy

Search content

Searches through project or version. Use this to build custom search into your own website/services which directs users to documentation. Minimum plan required is Grow plan. Rate limit: 10,800 in 60 minutes.

Auth

Query String

query	string	Search query
version_slug	string	Slug of the version to be searched. To use always the default published version, use 'latest'. Omit to search in the entire project
page	integer	Specify the page to retrieve. Numbering starts from 0. Default: 0
hits	integer	Number of hits to retrieve. Default: 20

GET /search

 
curl --get \ --url 'https://api.developerhub.io/api/v1/search' \ --header 'X-Api-Key: {X-Api-Key}' \ --data query=variables \ --data version_slug=v1.0 \ --data page=1 \ --data hits=20
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
SearchResult	object
hits	array[object]
content	string	Content where hit was found
title	string	Title of the hit. It is either the page title or the heading title for the hit if it is in a documentation page, or the name of the operation if it was in an API reference.
sectionType	string	Type of section: 'doc' for documentation or 'ref' for reference Enum: `doc`,`ref`
version	string	Name of version
section	string	Name of section
page	string	Name of page
pageId	number	Page ID
fragment	string	URL fragment
path	string	Path, without the host, to direct the user to to find the content
nbHits	integer	Number of hits retrieved
page	integer	Current page
nbPages	integer	Number of pages that can be searched for this query
hitsPerPage	integer	Number of hits per page
query	string	Query used
basepath	string	Basepath of the project, if any.
host	string	Host of the project including scheme.

400

Client Error

403

Access denied

429

Too many requests

Response

 
{ "hits": [  {   "content": "To use project variables in an API Reference, replace all occurrences of the variable with the variable reference. For example, one definition property could be:\nversion:\n    type: string\n    description: Version of the API\n    example: \"%versions.last_version%\"\n\n\nWarning\nNote that YAML requires you to use double quotations to escape a string containing percent sign.\nKnown Limitations\n\nVariables do not work as HREFs for links.\n",   "title": "Using Project Variables in References",   "sectionType": "doc",   "version": "v1.0",   "section": "Support Center",   "page": "Variables",   "pageId": 86444,   "fragment": "using-project-variables-in-references",   "path": "/v1.0/support-center/variables#using-project-variables-in-references"  } ], "nbHits": 20, "page": 1, "nbPages": 3, "hitsPerPage": 20, "query": "variables", "basepath": "docs", "host": "https://docs.pied-piper.com"}
Copy

Get all resources

Returns all pages, documentation, references and versions of your project. Rate limit: 30 in 60 minutes.

Auth

GET /all

 
curl --get \ --url 'https://api.developerhub.io/api/v1/all' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
AllProject	object	All resources in a project
page	object	A key-value dictionary mapping of page ID to page details
*	object
title	string	Page title
updated	string	Date of last update
documentationId	integer	Documentation ID
listed	boolean	True if page is accessible for readers
documentation	object	A key-value dictionary mapping of documentation ID to documentation details
*	object
title	string	Documentation title
versionId	integer	Version ID
reference	object	A key-value dictionary mapping of reference ID to reference details
*	object
title	string	Reference title
versionId	integer	Version ID
version	object	A key-value dictionary mapping of version ID to version details
*	object
name	string	Version title
published	boolean	True if it can be viewed by readers

403

Access denied

429

Too many requests

Response

 
{ "page": {  "6177": {   "title": "Getting Started",   "updated": "2019-03-20T19:02:14+0000",   "documentationId": 412,   "listed": true  } }, "documentation": {  "412": {   "title": "Support Center",   "versionId": 310  } }, "reference": {  "917": {   "title": "Support Center",   "versionId": 310  } }, "version": {  "310": {   "name": "v1.0",   "published": true  } }}
Copy

Get audit log

Query the audit log. Only available in enterprise plans. Rate limit: 600 in 60 minutes.

Auth

Query String

scopes	array	Scope of the audit logs. Enum: `content`,`users`,`hosting`,`security`,`plan`,`other` Default: ["content"]
max_date	string	Maximum date to retrieve audits in Y-m-d\TH:i:sP format. Note that "+" character must be encoded to "%2B"
hits	integer	Number of hits to retrieve. Maximum is 100 Default: 20
cursor	string	Cursor for next page of results

GET /audit

 
curl --get \ --url 'https://api.developerhub.io/api/v1/audit' \ --header 'X-Api-Key: {X-Api-Key}' \ --data scopes=content \ --data max_date=2021-01-24T17:06:24+00:00 \ --data hits=20 \ --data cursor=XAr
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
object	object
data	array[object]
ipAddress	string	IP Address of the user who made the change
entity	string	Type of entity. Enum: `page`,`documentation`,`reference`,`version`,`project`,`landing-page`,`index`,`project-import`,`project-user`
entityId	string	ID of entity
details	object	Changes to the entity
scope	string	Scope of the change
message	string	Message describing the change
operation	string	Operation of the change Enum: `INS`,`UPD`,`DEL`,`READ`,`ADD`,`REM`
timestamp	string	Date of change
user	string	User making the change
apiKey	boolean	True if change was authenticated through an API Key
count	integer	Number of hits retrieved
total	integer	Total number of hits retrievable
cursor	string	Cursor for next page of results. Null value if there are no more results

400

Client Error

403

Access denied

429

Too many requests

Response

 
{ "data": [  {   "ipAddress": "81.123.55.209",   "entity": "page",   "entityId": "452",   "details": {},   "scope": "content",   "message": "edited",   "operation": "INS",   "timestamp": "2021-01-19T20:43:56+00:00",   "user": "829 <hello@developerhub.io>",   "apiKey": false  } ], "count": 20, "total": 620, "cursor": "XAr"}
Copy

Get users

Get all users and their roles. Rate limit: 3600 in 60 minutes.

Auth

GET /users

 
curl --get \ --url 'https://api.developerhub.io/api/v1/users' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
User	array[object]	OK
id	integer	Unique identifier
name	string	User name
email	string	User e-mail address
role	string	Role of user Enum: `ADMIN`,`PUBLISHER`,`WRITER`,`REVIEWER`
lastActiveAt	string	Date of last time user accessed DeveloperHub

400

Client Error

403

Access denied

429

Too many requests

Response

 
[ {  "id": 3609,  "name": "Peter Griffin",  "email": "peter@example.com",  "role": "ADMIN",  "lastActiveAt": "2021-03-20T19:02:14+0000" }]
Copy

Changelog

Operations for creating and listing changelog posts.

Create a changelog post

Creates a changelog post from Markdoc content, optionally publishing it immediately. The slug is generated from the title if not provided. Permission: changelog.edit. Rate limit: 10800 in 1 hour.

Auth

Path Params

integer

Changelog ID

Request Body

object	object	Changelog post object
title	string	Title of the changelog post
content	string	Contents of the post in Markdoc format
slug	string	Slug in the URL. Must match `^[a-zA-Z0-9-]+$`. Generated from the title if not provided
published	boolean	Publish the post immediately Default: false

POST /changelog/{id}/post

 
curl --request POST \ --url 'https://api.developerhub.io/api/v1/changelog/{id}/post' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "title": "26 May 2026",  "content": "We just shipped **2.0**\n\n## Highlights\n- Faster search\n",  "slug": "26-may-2026",  "published": "{boolean}"}'
Copy

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Changelog Post	object	Changelog post object
id	integer	Unique identifier
title	string	Title of the changelog post
slug	string	Slug in the URL
published	boolean	True if the post is published
content	string?	Contents of the post in Markdoc format. Null if the post has no content.
created	string	Date of creation
updated	string	Date of last update

400

Client Error

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

List changelog posts

Lists a changelog's posts, newest first. Returns the 10 most recent posts by default; use cursor to page. Permission: changelog.read. Rate limit: 600 in 60 seconds.

Auth

Path Params

integer

Changelog ID

Query String

count

integer

Number of posts to retrieve. Maximum is 50

Default: 10

cursor

string

Cursor for next page of results

GET /changelog/{id}/post

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Changelog Post List	object	Paginated list of changelog posts
posts	array[object]
id	integer	Unique identifier
title	string	Title of the changelog post
slug	string	Slug in the URL
published	boolean	True if the post is published
content	string?	Contents of the post in Markdoc format. Null if the post has no content.
created	string	Date of creation
updated	string	Date of last update
count	integer	Number of posts retrieved
total	integer	Total number of posts in the changelog
cursor	string?	Cursor for next page of results. Null value if there are no more results

403

Access denied

429

Too many requests

Response

Reader Access

Get access details of all invited readers

Get access details of all invited readers. Rate limit: 3600 in 60 minutes.

Auth

GET /reader-access

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Reader Access	array[object]	Reader access details
email	string	Reader e-mail address
expiresAt	string?	Date when the access expires. Null if it never expires.
created	string	Date of access creation
revoked	string?	Date when revoked. Null if not revoked.

400

Client Error

403

Access denied

429

Too many requests

Response

Grant access to reader

Grants access to reader. Only applicable when project is protected by "Email Invite". Rate limit: 100 in 60 minutes.

Auth

Request Body

object	object	Reader access object
email	string	Email address of reader
expiresAt	string?	Date of expiry in Y-m-d\TH:i:sP format

POST /reader-access

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Reader Access	object	Reader Access
email	string	Reader e-mail address
expiresAt	string?	Date when the access expires. Null if it never expires.
created	string	Date of access creation
revoked	string?	Date when revoked. Null if not revoked.

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

Revoke access to reader

Revokes access to reader. Rate limit: 100 in 60 minutes.

Auth

Request Body

object	object	Reader access object
email	string	Email address of reader

PATCH /reader-access

Responses

200

Headers
X-RateLimit-Limit	integer	Requests permitted until reset time
X-RateLimit-Remaining	integer	Requests consumed in current period
X-RateLimit-Reset	integer	Unix timestamp at which requests consumed will reset
Body
Reader Access	object	Reader Access
email	string	Reader e-mail address
expiresAt	string?	Date when the access expires. Null if it never expires.
created	string	Date of access creation
revoked	string?	Date when revoked. Null if not revoked.

403

Access denied

415

Unsupported content-type

429

Too many requests

Response