API docs by Redocly

Admin API (1.0.0)

Download OpenAPI specification:

Auth

Check if user is authenticated

Responses

Response samples

Content type
application/json
{
  • "authenticated": true,
  • "username": "string"
}

Login with username and password

Request Body schema: application/json
required
username
required
string
password
required
string
remember_me
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "remember_me": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Logout and invalidate session

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

getBuildInfo

Responses

Response samples

Content type
application/json
{
  • "buildTime": "string",
  • "gitCommit": "string",
  • "gitShortCommit": "string",
  • "gitBranch": "string",
  • "gitTag": "string",
  • "githubUrl": "string"
}

Get latest entries

query Parameters
last_last_edited_at
string <date-time>

Filter entries by the last edited date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new entry

Request Body schema: application/json
required
title
string

The title of the new entry

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "path": "string"
}

Get all entry titles

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete an entry

path Parameters
path
required
string

The path of the entry to delete

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get entry by dynamic path

path Parameters
path
required
string

The path of the entry

Responses

Response samples

Content type
application/json
{
  • "Path": "string",
  • "Title": "string",
  • "Body": "string",
  • "Visibility": "string",
  • "Format": "string",
  • "PublishedAt": "2019-08-24T14:15:22Z",
  • "LastEditedAt": "2019-08-24T14:15:22Z",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "ImageUrl": "string"
}

Update entry body

path Parameters
path
required
string

The path of the entry to update

Request Body schema: application/json
required
body
required
string

The new content of the entry

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Get linked entry paths

path Parameters
path
required
string

The source entry path

Responses

Response samples

Content type
application/json
{
  • "newLinks": [
    ],
  • "links": [
    ],
  • "twohops": [
    ]
}

Get linked entry paths

path Parameters
path
required
string

The source entry path

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Regenerate entry image

path Parameters
path
required
string

The path of the entry to regenerate the image for

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update entry title

path Parameters
path
required
string

The path of the entry to update

Request Body schema: application/json
required
title
required
string

The new title for the entry

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Update entry visibility

path Parameters
path
required
string

The path of the entry to update visibility

Request Body schema: application/json
required
visibility
required
string

The new visibility status for the entry

Responses

Request samples

Content type
application/json
{
  • "visibility": "string"
}

Response samples

Content type
application/json
{
  • "visibility": "string"
}

uploadFile

Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{}