Info

Partitioning

Our API is divided into two distinct parts - public and private. Both are documented, but you will need an API key to access any private functions of the API. You can request access to it from us by contacting us directly as described on the community page.

If you have been granted access, you may log into your account and manage your API keys on this page.

Please note that some of the private APIs are only accessible by admins. They are documented below as well.

Usage

Our API is relatively straightforward, and provides multiple data types and methods of authentication. You use the following base URI for all API requests:

https://glowstone.net/api/{version}/

The current API version is v1.

Authentication

For endpoints that require an API key, you have two options for authentication.

  • Set the api_key URI parameter or POST data key to your API key
  • Set the Authorization header to your API key

Data types

We support the following data types, which you can specify using the Accepts header:

  • application/json
  • application/xml
  • application/x-yaml

If you don't specify this header, application/json will be assumed.

Endpoints

Public

All public endpoints are read-only, and so only support the GET method.

GET /api/v1/news

Get the latest news posts as presented on the news page.

Parameters

Key Optional Info
page Request a specific page of news posts

Returned data

Key Type Info
page Integer Current page number
pages Integer Total number of available pages
posts List List of News Post objects
GET /api/v1/news/:id

Get a particular news post by ID. This is an integer that represents the news post uniquely, and you can also find this used for the display page for each individual news post.

Parameters

Key Optional Info
:id The post ID. Part of the URL.

Returned data

This endpoint returns a single News Post object.
GET /api/v1/news/latest

Get the latest news post.

Parameters

This endpoint has no parameters.

Returned data

This endpoint returns a single News Post object.

Objects

News post
Key Type Info
comment_url String or None URL pointing to a forum post that may be used for comments. May be null/None if a post isn't linked yet.
id Integer Post ID
html String Rendered HTML content
markdown String Markdown source code
posted String (Datetime) Date of posting
summary String HTML-stripped summary
title String Post title
user User object Post author
User
Key Type Info
id Integer User ID
username String Username

Sample data

The below sample data serves as an example of the structure of each of the returned data types. Each example is taken from the news endpoint, /api/v1/news.

application/json
{
  "page": 1,
  "pages": 1,
  "posts": [
    {
      "id": 2,
      "user": {
        "id": 1,
        "username": "gdude2002"
      },
      "posted": "2017-06-24 17:37:01.028621",
      "title": "We now have a CLA",
      "summary": "This is an announcement to let everyone know that we have come up with a CLA, otherwise known as a Contributor License Agreement. It's something we've been thinking about doing for a while, but decided that it deserved extra attention in light of  the swift movement on Bountysource .",
      "markdown": "This is an announcement to let everyone know that we have come up with a CLA, otherwise known as a Contributor License Agreement. It's something we've been thinking about doing for a while, but decided that it deserved extra attention in light of [the swift movement on Bountysource](https://www.bountysource.com/issues/40545454-185-completing-entities-in-glowstone).\r\n\r\nCLAs can look a bit scary, but every contributor submitting a pull request to Glowstone will be required to sign it. We've attempted to make that process as easy as possible - going forward, any new pull requests will automatically get a comment from the CLA helper. To sign the CLA, simply click the button in that comment and sign in with GitHub on the CLA helper site.\r\n\r\nIn short, by signing the Glowstone CLA, you confirm that:\r\n\r\n* Anyone can use your contributions anywhere, for free, forever\r\n* Your contributions do not infringe on anyone else's rights, including Mojang's\r\n\r\nIf you'd like to read the CLA yourself, it's available [here](https://glowstone.net/cla).\r\n\r\nNote that we are not requiring previous contributors to sign the CLA, but if you do sign it, it applies retroactively.\r\n\r\n---\r\n\r\nIf you would like to sign off your own bat before you make any further contributions or do any more work on your forks, feel free to do so  [here](https://cla-assistant.io/GlowstoneMC/Glowstone).",
      "html": "<p>This is an announcement to let everyone know that we have come up with a CLA, otherwise known as a Contributor License Agreement. It's something we've been thinking about doing for a while, but decided that it deserved extra attention in light of <a href=\"https://www.bountysource.com/issues/40545454-185-completing-entities-in-glowstone\" target=\"_blank\">the swift movement on Bountysource</a>.</p>\n<p>CLAs can look a bit scary, but every contributor submitting a pull request to Glowstone will be required to sign it. We've attempted to make that process as easy as possible - going forward, any new pull requests will automatically get a comment from the CLA helper. To sign the CLA, simply click the button in that comment and sign in with GitHub on the CLA helper site.</p>\n<p>In short, by signing the Glowstone CLA, you confirm that:</p>\n<ul>\n<li>Anyone can use your contributions anywhere, for free, forever</li>\n<li>Your contributions do not infringe on anyone else's rights, including Mojang's</li>\n</ul>\n<p>If you'd like to read the CLA yourself, it's available <a href=\"https://glowstone.net/cla\" target=\"_blank\">here</a>.</p>\n<p>Note that we are not requiring previous contributors to sign the CLA, but if you do sign it, it applies retroactively.</p>\n<hr/>\n<p>If you would like to sign off your own bat before you make any further contributions or do any more work on your forks, feel free to do so  <a href=\"https://cla-assistant.io/GlowstoneMC/Glowstone\" target=\"_blank\">here</a>.</p>\n"
    },
    {
      "id": 1,
      "user": {
        "id": 1,
        "username": "gdude2002"
      },
      "posted": "2017-06-20 12:57:30.317791",
      "title": "New Site (Beta)",
      "summary": "Hello, fellow Glowstone... ers...?",
      "markdown": "Hello, fellow Glowstone... ers...?\r\n\r\nWelcome to the beta version of the new site! We've decided that the site could use a small facelift and the addition of some much-needed functionality, and this is a preview of what's to come. Some of the things you can look forward to include:\r\n\r\n* Better syndication for news\r\n    * Currently, news posts are notified on the forum and across Twitter and Discord, and more can be added easily as required\r\n    * We also have RSS and ATOM feeds available [here](/feeds)\r\n* A proper downloads center for everything Glowstone\r\n    * We haven't done tons of work on this yet, but it'll be coming over the following couple of weeks\r\n* A central location to learn about our community and how you can help with the project, as well as better sourcing for documentation\r\n\r\nCurrently the beta site is in a relatively early stage, and not everything works. We would appreciate if you are able to give us feedback on this - you can do so on [GitHub](https://github.com/GlowstoneMC/Site), on [the forums](https://forums.glowstone.net), or on [Discord](https://discord.gg/TFJqhsC).\r\n\r\nWe want to make sure this site will work well for everyone, so don't be afraid to speak up if there's something you don't like!",
      "html": "<p>Hello, fellow Glowstone... ers...?</p>\n<p>Welcome to the beta version of the new site! We've decided that the site could use a small facelift and the addition of some much-needed functionality, and this is a preview of what's to come. Some of the things you can look forward to include:</p>\n<ul>\n<li>Better syndication for news\n<ul>\n<li>Currently, news posts are notified on the forum and across Twitter and Discord, and more can be added easily as required</li>\n<li>We also have RSS and ATOM feeds available <a href=\"/feeds\" target=\"_blank\">here</a></li>\n</ul></li>\n<li>A proper downloads center for everything Glowstone\n<ul>\n<li>We haven't done tons of work on this yet, but it'll be coming over the following couple of weeks</li>\n</ul></li>\n<li>A central location to learn about our community and how you can help with the project, as well as better sourcing for documentation</li>\n</ul>\n<p>Currently the beta site is in a relatively early stage, and not everything works. We would appreciate if you are able to give us feedback on this - you can do so on <a href=\"https://github.com/GlowstoneMC/Site\" target=\"_blank\">GitHub</a>, on <a href=\"https://forums.glowstone.net\" target=\"_blank\">the forums</a>, or on <a href=\"https://discord.gg/TFJqhsC\" target=\"_blank\">Discord</a>.</p>\n<p>We want to make sure this site will work well for everyone, so don't be afraid to speak up if there's something you don't like!</p>\n"
    }
  ]
}
application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<root>
    <page type="int">1</page>
    <pages type="int">1</pages>
    <posts type="list">
        <item type="dict">
            <id type="int">2</id>
            <user type="dict">
                <id type="int">1</id>
                <username type="str">gdude2002</username>
            </user>
            <posted type="str">2017-06-24 17:37:01.028621</posted>
            <title type="str">We now have a CLA</title>
            <summary type="str">This is an announcement to let everyone know that we have come up with a CLA, otherwise
                known as a Contributor License Agreement. It&apos;s something we&apos;ve been thinking about doing for a
                while, but decided that it deserved extra attention in light of the swift movement on Bountysource .
            </summary>
            <markdown type="str">This is an announcement to let everyone know that we have come up with a CLA, otherwise
                known as a Contributor License Agreement. It&apos;s something we&apos;ve been thinking about doing for a
                while, but decided that it deserved extra attention in light of [the swift movement on
                Bountysource](https://www.bountysource.com/issues/40545454-185-completing-entities-in-glowstone).

                CLAs can look a bit scary, but every contributor submitting a pull request to Glowstone will be required
                to sign it. We&apos;ve attempted to make that process as easy as possible - going forward, any new pull
                requests will automatically get a comment from the CLA helper. To sign the CLA, simply click the button
                in that comment and sign in with GitHub on the CLA helper site.

                In short, by signing the Glowstone CLA, you confirm that:

                * Anyone can use your contributions anywhere, for free, forever
                * Your contributions do not infringe on anyone else&apos;s rights, including Mojang&apos;s

                If you&apos;d like to read the CLA yourself, it&apos;s available [here](https://glowstone.net/cla).

                Note that we are not requiring previous contributors to sign the CLA, but if you do sign it, it applies
                retroactively.

                ---

                If you would like to sign off your own bat before you make any further contributions or do any more work
                on your forks, feel free to do so [here](https://cla-assistant.io/GlowstoneMC/Glowstone).
            </markdown>
            <html type="str">&lt;p&gt;This is an announcement to let everyone know that we have come up with a CLA,
                otherwise known as a Contributor License Agreement. It&apos;s something we&apos;ve been thinking about
                doing for a while, but decided that it deserved extra attention in light of &lt;a href=&quot;https://www.bountysource.com/issues/40545454-185-completing-entities-in-glowstone&quot;
                target=&quot;_blank&quot;&gt;the swift movement on Bountysource&lt;/a&gt;.&lt;/p&gt;
                &lt;p&gt;CLAs can look a bit scary, but every contributor submitting a pull request to Glowstone will be
                required to sign it. We&apos;ve attempted to make that process as easy as possible - going forward, any
                new pull requests will automatically get a comment from the CLA helper. To sign the CLA, simply click
                the button in that comment and sign in with GitHub on the CLA helper site.&lt;/p&gt;
                &lt;p&gt;In short, by signing the Glowstone CLA, you confirm that:&lt;/p&gt;
                &lt;ul&gt;
                &lt;li&gt;Anyone can use your contributions anywhere, for free, forever&lt;/li&gt;
                &lt;li&gt;Your contributions do not infringe on anyone else&apos;s rights, including Mojang&apos;s&lt;/li&gt;
                &lt;/ul&gt;
                &lt;p&gt;If you&apos;d like to read the CLA yourself, it&apos;s available &lt;a href=&quot;https://glowstone.net/cla&quot;
                target=&quot;_blank&quot;&gt;here&lt;/a&gt;.&lt;/p&gt;
                &lt;p&gt;Note that we are not requiring previous contributors to sign the CLA, but if you do sign it, it
                applies retroactively.&lt;/p&gt;
                &lt;hr/&gt;
                &lt;p&gt;If you would like to sign off your own bat before you make any further contributions or do any
                more work on your forks, feel free to do so &lt;a href=&quot;https://cla-assistant.io/GlowstoneMC/Glowstone&quot;
                target=&quot;_blank&quot;&gt;here&lt;/a&gt;.&lt;/p&gt;
            </html>
        </item>
        <item type="dict">
            <id type="int">1</id>
            <user type="dict">
                <id type="int">1</id>
                <username type="str">gdude2002</username>
            </user>
            <posted type="str">2017-06-20 12:57:30.317791</posted>
            <title type="str">New Site (Beta)</title>
            <summary type="str">Hello, fellow Glowstone... ers...?</summary>
            <markdown type="str">Hello, fellow Glowstone... ers...?

                Welcome to the beta version of the new site! We&apos;ve decided that the site could use a small facelift
                and the addition of some much-needed functionality, and this is a preview of what&apos;s to come. Some
                of the things you can look forward to include:

                * Better syndication for news
                * Currently, news posts are notified on the forum and across Twitter and Discord, and more can be added
                easily as required
                * We also have RSS and ATOM feeds available [here](/feeds)
                * A proper downloads center for everything Glowstone
                * We haven&apos;t done tons of work on this yet, but it&apos;ll be coming over the following couple of
                weeks
                * A central location to learn about our community and how you can help with the project, as well as
                better sourcing for documentation

                Currently the beta site is in a relatively early stage, and not everything works. We would appreciate if
                you are able to give us feedback on this - you can do so on
                [GitHub](https://github.com/GlowstoneMC/Site), on [the forums](https://forums.glowstone.net), or on
                [Discord](https://discord.gg/TFJqhsC).

                We want to make sure this site will work well for everyone, so don&apos;t be afraid to speak up if there&apos;s
                something you don&apos;t like!
            </markdown>
            <html type="str">&lt;p&gt;Hello, fellow Glowstone... ers...?&lt;/p&gt;
                &lt;p&gt;Welcome to the beta version of the new site! We&apos;ve decided that the site could use a small
                facelift and the addition of some much-needed functionality, and this is a preview of what&apos;s to
                come. Some of the things you can look forward to include:&lt;/p&gt;
                &lt;ul&gt;
                &lt;li&gt;Better syndication for news
                &lt;ul&gt;
                &lt;li&gt;Currently, news posts are notified on the forum and across Twitter and Discord, and more can
                be added easily as required&lt;/li&gt;
                &lt;li&gt;We also have RSS and ATOM feeds available &lt;a href=&quot;/feeds&quot; target=&quot;_blank&quot;&gt;here&lt;/a&gt;&lt;/li&gt;
                &lt;/ul&gt;&lt;/li&gt;
                &lt;li&gt;A proper downloads center for everything Glowstone
                &lt;ul&gt;
                &lt;li&gt;We haven&apos;t done tons of work on this yet, but it&apos;ll be coming over the following
                couple of weeks&lt;/li&gt;
                &lt;/ul&gt;&lt;/li&gt;
                &lt;li&gt;A central location to learn about our community and how you can help with the project, as well
                as better sourcing for documentation&lt;/li&gt;
                &lt;/ul&gt;
                &lt;p&gt;Currently the beta site is in a relatively early stage, and not everything works. We would
                appreciate if you are able to give us feedback on this - you can do so on &lt;a href=&quot;https://github.com/GlowstoneMC/Site&quot;
                target=&quot;_blank&quot;&gt;GitHub&lt;/a&gt;, on &lt;a href=&quot;https://forums.glowstone.net&quot;
                target=&quot;_blank&quot;&gt;the forums&lt;/a&gt;, or on &lt;a href=&quot;https://discord.gg/TFJqhsC&quot;
                target=&quot;_blank&quot;&gt;Discord&lt;/a&gt;.&lt;/p&gt;
                &lt;p&gt;We want to make sure this site will work well for everyone, so don&apos;t be afraid to speak up
                if there&apos;s something you don&apos;t like!&lt;/p&gt;
            </html>
        </item>
    </posts>
</root>
application/x-yaml
page: 1
pages: 1
posts:
- html: "<p>This is an announcement to let everyone know that we have come up with\
    \ a CLA, otherwise known as a Contributor License Agreement. It's something we've\
    \ been thinking about doing for a while, but decided that it deserved extra attention\
    \ in light of <a href=\"https://www.bountysource.com/issues/40545454-185-completing-entities-in-glowstone\"\
    \ target=\"_blank\">the swift movement on Bountysource</a>.</p>\n<p>CLAs can look\
    \ a bit scary, but every contributor submitting a pull request to Glowstone will\
    \ be required to sign it. We've attempted to make that process as easy as possible\
    \ - going forward, any new pull requests will automatically get a comment from\
    \ the CLA helper. To sign the CLA, simply click the button in that comment and\
    \ sign in with GitHub on the CLA helper site.</p>\n<p>In short, by signing the\
    \ Glowstone CLA, you confirm that:</p>\n<ul>\n<li>Anyone can use your contributions\
    \ anywhere, for free, forever</li>\n<li>Your contributions do not infringe on\
    \ anyone else's rights, including Mojang's</li>\n</ul>\n<p>If you'd like to read\
    \ the CLA yourself, it's available <a href=\"https://glowstone.net/cla\"\
    \ target=\"_blank\">here</a>.</p>\n<p>Note that we are not requiring previous\
    \ contributors to sign the CLA, but if you do sign it, it applies retroactively.</p>\n\
    <hr/>\n<p>If you would like to sign off your own bat before you make any further\
    \ contributions or do any more work on your forks, feel free to do so  <a href=\"\
    https://cla-assistant.io/GlowstoneMC/Glowstone\" target=\"_blank\">here</a>.</p>\n"
  id: 2
  markdown: "This is an announcement to let everyone know that we have come up with\
    \ a CLA, otherwise known as a Contributor License Agreement. It's something we've\
    \ been thinking about doing for a while, but decided that it deserved extra attention\
    \ in light of [the swift movement on Bountysource](https://www.bountysource.com/issues/40545454-185-completing-entities-in-glowstone).\r\
    \n\r\nCLAs can look a bit scary, but every contributor submitting a pull request\
    \ to Glowstone will be required to sign it. We've attempted to make that process\
    \ as easy as possible - going forward, any new pull requests will automatically\
    \ get a comment from the CLA helper. To sign the CLA, simply click the button\
    \ in that comment and sign in with GitHub on the CLA helper site.\r\n\r\nIn short,\
    \ by signing the Glowstone CLA, you confirm that:\r\n\r\n* Anyone can use your\
    \ contributions anywhere, for free, forever\r\n* Your contributions do not infringe\
    \ on anyone else's rights, including Mojang's\r\n\r\nIf you'd like to read the\
    \ CLA yourself, it's available [here](https://glowstone.net/cla).\r\n\r\n\
    Note that we are not requiring previous contributors to sign the CLA, but if you\
    \ do sign it, it applies retroactively.\r\n\r\n---\r\n\r\nIf you would like to\
    \ sign off your own bat before you make any further contributions or do any more\
    \ work on your forks, feel free to do so  [here](https://cla-assistant.io/GlowstoneMC/Glowstone)."
  posted: '2017-06-24 17:37:01.028621'
  summary: This is an announcement to let everyone know that we have come up with
    a CLA, otherwise known as a Contributor License Agreement. It's something we've
    been thinking about doing for a while, but decided that it deserved extra attention
    in light of  the swift movement on Bountysource .
  title: We now have a CLA
  user: {id: 1, username: gdude2002}
- html: "<p>Hello, fellow Glowstone... ers...?</p>\n<p>Welcome to the beta version\
    \ of the new site! We've decided that the site could use a small facelift and\
    \ the addition of some much-needed functionality, and this is a preview of what's\
    \ to come. Some of the things you can look forward to include:</p>\n<ul>\n<li>Better\
    \ syndication for news\n<ul>\n<li>Currently, news posts are notified on the forum\
    \ and across Twitter and Discord, and more can be added easily as required</li>\n\
    <li>We also have RSS and ATOM feeds available <a href=\"/feeds\" target=\"_blank\"\
    >here</a></li>\n</ul></li>\n<li>A proper downloads center for everything Glowstone\n\
    <ul>\n<li>We haven't done tons of work on this yet, but it'll be coming over the\
    \ following couple of weeks</li>\n</ul></li>\n<li>A central location to learn\
    \ about our community and how you can help with the project, as well as better\
    \ sourcing for documentation</li>\n</ul>\n<p>Currently the beta site is in a relatively\
    \ early stage, and not everything works. We would appreciate if you are able to\
    \ give us feedback on this - you can do so on <a href=\"https://github.com/GlowstoneMC/Site\"\
    \ target=\"_blank\">GitHub</a>, on <a href=\"https://forums.glowstone.net\" target=\"\
    _blank\">the forums</a>, or on <a href=\"https://discord.gg/TFJqhsC\" target=\"\
    _blank\">Discord</a>.</p>\n<p>We want to make sure this site will work well for\
    \ everyone, so don't be afraid to speak up if there's something you don't like!</p>\n"
  id: 1
  markdown: "Hello, fellow Glowstone... ers...?\r\n\r\nWelcome to the beta version\
    \ of the new site! We've decided that the site could use a small facelift and\
    \ the addition of some much-needed functionality, and this is a preview of what's\
    \ to come. Some of the things you can look forward to include:\r\n\r\n* Better\
    \ syndication for news\r\n    * Currently, news posts are notified on the forum\
    \ and across Twitter and Discord, and more can be added easily as required\r\n\
    \    * We also have RSS and ATOM feeds available [here](/feeds)\r\n* A proper\
    \ downloads center for everything Glowstone\r\n    * We haven't done tons of work\
    \ on this yet, but it'll be coming over the following couple of weeks\r\n* A central\
    \ location to learn about our community and how you can help with the project,\
    \ as well as better sourcing for documentation\r\n\r\nCurrently the beta site\
    \ is in a relatively early stage, and not everything works. We would appreciate\
    \ if you are able to give us feedback on this - you can do so on [GitHub](https://github.com/GlowstoneMC/Site),\
    \ on [the forums](https://forums.glowstone.net), or on [Discord](https://discord.gg/TFJqhsC).\r\
    \n\r\nWe want to make sure this site will work well for everyone, so don't be\
    \ afraid to speak up if there's something you don't like!"
  posted: '2017-06-20 12:57:30.317791'
  summary: Hello, fellow Glowstone... ers...?
  title: New Site (Beta)
  user: {id: 1, username: gdude2002}

We are proudly sponsored by Aternos

Minecraft Servers. Free. Forever.