API 1.0.1

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.

All operations require an API key, read Authentication.

All operations (except Search content) must be called from a back-end. Cross-origin requests are not allowed.

Server

https://api.developerhub.dev/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

POST

/documentation/{id}/page

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. Permission: page.edit

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 Darkdown format
categoryTitle	string	To append the page to a category, provide the pre-existing category title here (case insensitive)
message	string	Page history message Default: Created using API

POST /documentation/{id}/page

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.developerhub.dev/api/v1/documentation/%7Bid%7D/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",  "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
contentDraft	string	Draft content in the selected format
contentPublished	string	Published content in the selected format
path	string	Path of the page without the project basepath (if any)

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

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

Publish a page

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

Auth

Path Params

integer

Page ID

PUT /page/{id}/publish

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.developerhub.dev/api/v1/page/%7Bid%7D/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
contentDraft	string	Draft content in the selected format
contentPublished	string	Published content in the selected format
path	string	Path of the page without the project basepath (if any)

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

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

Get page by slug

Get a page by slugs and read its content in Darkdown, markdown, HTML, or text 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. Permission: page.read

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: `darkdown`,`markdown`,`html`,`text` Default: darkdown

GET /page

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/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=darkdown
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
contentDraft	string	Draft content in the selected format
contentPublished	string	Published content in the selected format
path	string	Path of the page without the project basepath (if any)

403

Access denied

429

Too many requests

Response

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

Read page

Read a page including its content in Darkdown, markdown, HTML, or text format. Rate limit: 600 in 1 minute. Permission: page.read

Auth

Path Params

integer

Page ID

Query String

format

string

Format type

Enum: darkdown,markdown,html,text

Default: darkdown

GET /page/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/api/v1/page/%7Bid%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data format=darkdown
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
contentDraft	string	Draft content in the selected format
contentPublished	string	Published content in the selected format
path	string	Path of the page without the project basepath (if any)

403

Access denied

429

Too many requests

Response

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

Update a page

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

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 Darkdown format
message	string	Page history message Default: Updated using API

PUT /page/{id}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.developerhub.dev/api/v1/page/%7Bid%7D' \ --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",  "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
contentDraft	string	Draft content in the selected format
contentPublished	string	Published content in the selected format
path	string	Path of the page without the project basepath (if any)

403

Access denied

415

Unsupported content-type

429

Too many requests

Response

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

Version

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. Permission: project.read

Auth

GET /version

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/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

xxxxxxxxxx
 
[ {  "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. Permission: version.publish

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}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.developerhub.dev/api/v1/version/%7Bid%7D' \ --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

xxxxxxxxxx
 
{ "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

Reference

GET

/reference/{id}/definition

POST

/version/{versionId}/reference

PUT

/reference/{id}/publish

Read reference

Reads a reference definition. Permission: reference.read. Rate limit: 600 in 60 seconds.

Auth

Path Params

string

The reference ID

Query String

draft

boolean

Get draft definition

format

string

Get definition in format

Enum: auto,yaml,json

Default: auto

GET /reference/{id}/definition

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/api/v1/reference/%7Bid%7D/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	OpenAPI definition

403

Access denied

429

Too many requests

Response

xxxxxxxxxx
 
{ "openapi": 1, "info": {  "version": "1.0.0",  "title": "API" }, "paths": {  "/list": {   "get": {    "description": "Gets the items"   }  } }}
Copy

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. Changes are published and do not pass through a draft state. Rate limit: 300 in 60 minutes. Permission: reference.publish

Auth

Path Params

versionId

string

The version ID

Query String

publish

boolean

By default true, set to false to write a draft instead. Permission needed would be reference.edit.

Default: true

Request Body

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

POST /version/{versionId}/reference

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.developerhub.dev/api/v1/version/%7BversionId%7D/reference' \ --header 'Content-Type: multipart/form-data' \ --header 'X-Api-Key: {X-Api-Key}' \ --data publish=true \ --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

xxxxxxxxxx
 
{ "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

Publish API reference

Publishes the draft of an API reference. Rate limit: 3600 in 1 hour. Permission: reference.publish

Auth

Path Params

number

The reference ID

PUT /reference/{id}/publish

xxxxxxxxxx
 
curl --request PUT \ --url 'https://api.developerhub.dev/api/v1/reference/%7Bid%7D/publish' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

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

xxxxxxxxxx
 
{ "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

Get users

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

Auth

GET /users

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/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

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

Exports project

Exports the project into a ZIP file. Only available for enterprise plans. Rate limit: 10 in 60 minutes. Permission: project.export

Auth

Query String

format

string

Format type

Enum: darkdown,markdown

Default: darkdown

GET /export

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/api/v1/export' \ --header 'X-Api-Key: {X-Api-Key}' \ --data format=darkdown
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

xxxxxxxxxx
 
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. Permission: search

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
section_slug	string	Slug of the section to be searched. Omit to search in the entire version. If `version_slug` is not set, the default published version would be used.
section_type	string	Type of the section. `doc` for documentation or `ref` for reference. Must be specified when `section_slug` is set. Enum: `doc`,`ref`
page	integer	Specify the page to retrieve. Numbering starts from 0.
hits	integer	Number of hits to retrieve. Default: 20

GET /search

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/api/v1/search' \ --header 'X-Api-Key: {X-Api-Key}' \ --data query=variables \ --data version_slug=v1.0 \ --data section_slug=docs \ --data section_type=doc \ --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.

Expand

400

Client Error

403

Access denied

429

Too many requests

Response

xxxxxxxxxx
 
{ "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. Permission: project.read

Auth

Query String

published	boolean	When true, only lists published items.
versionId	integer	The version to get all resources from. Use `latest` to automatically choose the default version.

GET /all

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/api/v1/all' \ --header 'X-Api-Key: {X-Api-Key}' \ --data published={published} \ --data versionId={versionId}
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
slug	string	Slug of the documentation in the URL
reference	object	A key-value dictionary mapping of reference ID to reference details
*	object
title	string	Reference title
versionId	integer	Version ID
slug	string	Slug of the reference in the URL
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
slug	string	Slug of the version in the URL

Expand

403

Access denied

429

Too many requests

Response

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

Get audit log

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

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

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/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

xxxxxxxxxx
 
{ "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

Reader Access

Get access details of all invited readers

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

Auth

GET /reader-access

xxxxxxxxxx
 
curl --get \ --url 'https://api.developerhub.dev/api/v1/reader-access' \ --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
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

xxxxxxxxxx
 
[ {  "email": "peter@example.com",  "expiresAt": "2022-04-20T19:03:14+0000",  "created": "2022-03-20T19:02:14+0000",  "revoked": "2022-03-22T20:02:15+0000" }]
Copy

Grant access to reader

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

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://api.developerhub.dev/api/v1/reader-access' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "email": "peter@example.com",  "expiresAt": "2022-01-01T03:02:01+0000"}'
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
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

xxxxxxxxxx
 
{ "email": "peter@example.com", "expiresAt": "2022-04-20T19:03:14+0000", "created": "2022-03-20T19:02:14+0000", "revoked": "2022-03-22T20:02:15+0000"}
Copy

Revoke access to reader

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

Auth

Request Body

object	object	Reader access object
email	string	Email address of reader

PATCH /reader-access

xxxxxxxxxx
 
curl --request PATCH \ --url 'https://api.developerhub.dev/api/v1/reader-access' \ --header 'Content-Type: application/json' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "email": "peter@example.com"}'
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
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

xxxxxxxxxx
 
{ "email": "peter@example.com", "expiresAt": "2022-04-20T19:03:14+0000", "created": "2022-03-20T19:02:14+0000", "revoked": "2022-03-22T20:02:15+0000"}
Copy