Documentation

Sensitivity

→ High
→ Medium
→ Low
→ None

Main
Endpoint



User
Endpoint







Alerts
Endpoint





Minecraft
Endpoint





Codity
Endpoint





MH-DNS
Endpoint



Need to verify your application or manually associate with a host? Get in touch with me via Discord (click me).
Not sure how to use the API? Read over the basic functionality of the API here (click me).

Announcements

The announcements section of the API allows you view a list of announcements.
The following values must be present in the request, but the format of the request will vary: sec = announcements.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"announcements retrieved",
	"data": 
	[
		{
			"id":"10098",
			"message":"This is an announcement.",
			"trn-date":"2017-10-22 22:34:43"
		},
		{
			"id":"10099",
			"message":"This is also an announcement.",
			"trn-date":"2017-10-22 22:34:43"
		},
		...
	]
}



User


Authentication

The authentication section of the user API allows you to authenticate a user. In order to authenticate a user, you must send the user to https://www.theartex.net/system/login/ and specify a redirect URL, such as https://www.theartex.net/system/login/?red=https://example.com.

Once authenticated, specific paramaters will be added to the specified redirect URL. These paramaters will contain the necessary data to authenticate users externally and thus access the rest of the API.

If you are authenticating through a local desktop or mobile application, you must specify an extra parameter type with the value of local. When authenticating through local applications, a minimal UI will always be shown. However, if you would like to use the minimal UI for other requests, an extra parameter type with the value of minimal must be present.

If you have trouble with authentication, please contact us and we will sort out your issue.


Example
{
	"id":"10099",
	"token":"FgaIcPTIqlYigqPPEeNN",
	"remember":"true"
}

Session

The session section of the user API allows you to update the status of a user.
The following values must be present in the request, but the format of the request will vary: sec = session, application = application name, domain or URL, ip = IPv4 address, id = user id and token = user token.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"session updated"
}

Validate

The validate section of the user API allows you to check if a token is valid.
The following values must be present in the request, but the format of the request will vary: sec = validate, id = user id and token = user token.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"user retrieved",
	"data":
	{
		"id":"10099",
		"username":"Example",
		"role":"User",
		"email":"[email protected]",
		"gravatar":"[email protected]",
		"application":"https://www.theartex.net/documentation/",
		"last_seen":"2017-10-22 22:34:43"
	}
}

ID

The ID section of the user API allows you to convert a username to an ID.
The following values must be present in the request, but the format of the request will vary: sec = id and username = username.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"user retrieved",
	"data":
	{
		"id":"10099",
		"name":"Example"
	}
}

Username

The username section of the user API allows you to convert an ID to a username.
The following values must be present in the request, but the format of the request will vary: sec = username and id = id.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"user retrieved",
	"data":
	{
		"id":"10099",
		"name":"Example"
	}
}



Alerts Endpoint


New

The new section of the alerts API allows you to create an alert.
The following values must be present in the request, but the format of the request will vary: sec = new, title = alert title, message = alert message, id = user id and token = user token.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"alert created",
	"data":
	{
		"id":"448"
	}
}

List

The list section of the alerts API allows you to view a list of alerts of a user.
The following values must be present in the request, but the format of the request will vary: sec = list, id = user id and token = user token.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"alerts retrieved",
	"data":
	[
		{
			"id":"346",
			"title":"Profile",
			"message":"Your profile has been successfully updated.",
			"status":"new",
			"trn_date":"2017-10-22 22:34:43"
		},
		{
			"id":"345",
			"title":"API",
			"message":"Your developer and user keys have been successfully created.",
			"status":"idle",
			"trn_date":"2017-10-22 22:34:43"
		},
		{
			"id":"344",
			"title":"mathhulk.me",
			"message":"Your project, Testing, has been updated.",
			"status":"old",
			"trn_date":"2017-10-22 22:34:43"
		}
		...
	]
}

Status

The status section of the alerts API allows you to update an alert.
The following values must be present in the request, but the format of the request will vary: sec = status, alert = alert id, status = status type, id = user id and token = user token.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"alert updated"
}



Minecraft Endpoint


Username

The username section of the Minecraft API allows you to get the username of a Minecraft player from their UUID.
The following values must be present in the request, but the format of the request will vary: sec = username and uuid = uuid.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"username retrieved",
	"data": 
	{
		"id":"e7ec6c61f69f437f89f888c4d1536395",
		"name":"mathhulk"
	}
}

UUID

The UUID section of the Minecraft API allows you to get the UUID of a Minecraft player from their username.
The following values must be present in the request, but the format of the request will vary: sec = uuid and username = username.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"uuid retrieved",
	"data": 
	{
		"id":"e7ec6c61f69f437f89f888c4d1536395",
		"name":"mathhulk"
	}
}

History

The history section of the Minecraft API allows you to view a list of usernames associated with a UUID.
The following values must be present in the request, but the format of the request will vary: sec = history and uuid = uuid.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"history retrieved",
	"data": 
	[
		{
			"name":"KingAlterIV"
		},
		{
			"name":"CorruptedS0ul",
			"changedToAt":1451346513000
		},
		{
			"name":"Karamatsu",
			"changedToAt":1457134037000
		}
	]
}



Codity Endpoint


Status

The status section of the Codity API allows you to view the details of a paste.
The following values must be present in the request, but the format of the request will vary: sec = status and id = paste.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"paste retrieved",
	"data": 
	{
		"name":"Public API",
		"username":"---",
		"url":"https://c.theartex.net/12iU3uRH8G",
		"raw":"https://c.theartex.net/raw/12iU3uRH8G",
		"trn_date":"2017-10-22 22:34:43",
	}
}

List

The list section of the Codity API allows you to view a list of pastes by a user.
The following values must be present in the request, but the format of the request will vary: sec = list and username = username.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"pastes retrieved",
	"data": 
	[
		{
			"name":"Public API",
			"id":"12iU3uRH8G",
			"url":"https://c.theartex.net/12iU3uRH8G",
			"raw":"https://c.theartex.net/raw/12iU3uRH8G",
			"trn_date":"2017-10-22 22:34:43",
		},
		{
			"name":"---",
			"id":"23r9ufnWE3",
			"url":"https://c.theartex.net/23r9ufnWE3",
			"raw":"https://c.theartex.net/raw/23r9ufnWE3",
			"trn_date":"2017-10-22 22:34:43",
		}
		...
	]
}

New

The new section of the Codity API allows you to create a paste.
The following values must be present in the request, but the format of the request will vary: sec = new, mode = programming language, content = paste content and key = user key. The following values are optional in the request: name = paste name.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"paste created",
	"data": 
	{
		"id":"12iU3uRH8G",
		"url":"https://c.theartex.net/12iU3uRH8G",
		"raw":"https://c.theartex.net/raw/12iU3uRH8G",
		"trn_date":"2017-10-22 22:34:43",
	}
}



MH-DNS Endpoint


Status

The status section of the MH-DNS API allows you to view the details of a record.
The following values must be present in the request, but the format of the request will vary: sec = status and id = record.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"record retrieved",
	"data": 
	{
		"name":"test",
		"domain":"mh-dns.us",
		"username":"mathhulk",
		"ip":"127.0.0.1",
		"port":"---",
		"trn_date":"2017-10-22 22:34:43",
	}
}

List

The list section of the MH-DNS API allows you to view a list of records by a user.
The following values must be present in the request, but the format of the request will vary: sec = list and username = username.


Example
{
	"status":"success",
	"code":"200",
	"host":"127.0.0.1",
	"message":"records retrieved",
	"data": 
	[
		{
			"id":"10078",
			"name":"test",
			"domain":"mh-dns.us",
			"ip":"127.0.0.1",
			"port":"---",
			"trn_date":"2017-10-22 22:34:43",
		},
		{
			"id":"10077",
			"name":"test",
			"paste":"mineserver.rocks",
			"ip":"68.101.23.48",
			"port":"25566",
			"trn_date":"2017-10-22 22:34:43",
		}
		...
	]
}
Top