Help Pages

Get Help Pages

GET https://e621.net/help.json

If an e621ng instance has no existing help pages, an error will be thrown. See e621ng/e621ng#492.

This endpoint accepts no search parameters.

200: OK Success (Results)

[
  {
    "created_at": "0000-00-00T00:00:00.000-00:00",
    "id": 0,
    "name": "name",
    "related": "", // separated by a comma and a space
    "title": "", // Defaults to a titleized version of the name (https://apidock.com/rails/String/titleize)
    "updated_at": "0000-00-00T00:00:00.000-00:00",
    "wiki_page": "help:wiki_page"
  }
]

500: Internal Server Error Success (No Results)

{
  "success": false,
  "message": "An unexpected error occurred.",
  "code": "00000000-0000-0000-0000-000000000000"
}

Get Help Page

GET https://e621.net/help/{nameOrID}.json

Path Parameters

Name	Type	Description
nameOrID*	String	The name or ID of the help page to get.

200: OK Success

{
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "id": 0,
  "name": "name",
  "related": "", // separated by a comma and a space
  "title": "", // Defaults to a titleized version of the name (https://apidock.com/rails/String/titleize)
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "wiki_page": "help:wiki_page"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Create Help Page

POST https://e621.net/help.json

Authorization Required

Admin+ Required

Request Body

Name	Type	Description
help_page[name]*	String	The name of the help page.
help_page[wiki_page]*	String	The name of the wiki page the help page will display.
help_page[title]	String	The title of the wiki page, Defaults to a titleized version of name.
help_page[related]	String	The related help pages, separated by a comma and a space.

200: OK Success

{
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "id": 0,
  "name": "name",
  "related": "", // separated by a comma and a space
  "title": "", // Defaults to a titleized version of the name (https://apidock.com/rails/String/titleize)
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "wiki_page": "help:wiki_page"
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

422: Unprocessable Entity Wiki Page In Use

{
  "errors": {
    "wiki_page": [
      "has already been taken"
    ]
  }
}

422: Unprocessable Entity Wiki Page Does Not Exist

{
  "errors": {
    "wiki_page": [
      "must exist"
    ]
  }
}

Edit Help Page

PATCH https://e621.net/help/{nameOrID}.json

Authorization Required

Admin+ Required

Path Parameters

Name	Type	Description
nameOrID*	String	The name or ID of the help page to edit.

Request Body

Name	Type	Description
help_page[name]	String	The name of the help page.
help_page[wiki_page]	String	The name of the wiki page the help page will display.
help_page[title]	String	The title of the wiki page, Defaults to a titleized version of name.
help_page[related]	String	The related help pages, separated by a comma and a space.

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

422: Unprocessable Entity Wiki Page In Use

{
  "errors": {
    "wiki_page": [
      "has already been taken"
    ]
  }
}

422: Unprocessable Entity Wiki Page Does Not Exist

{
  "errors": {
    "wiki_page": [
      "must exist"
    ]
  }
}

Delete Help Page

DELETE https://e621.net/help/{nameOrID}.json

Authorization Required

Admin+ Required

Path Parameters

Name	Type	Description
nameOrID*	String	The name or ID of the help page to delete.

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}