3814 lines
49 KiB
Markdown
3814 lines
49 KiB
Markdown
# Endpoints
|
||
|
||
|
||
## Responds with a status for heath check.
|
||
|
||
|
||
|
||
|
||
> Example request:
|
||
|
||
```bash
|
||
curl -X GET \
|
||
-G "http://localhost/api/ping" \
|
||
-H "Content-Type: application/json" \
|
||
-H "Accept: application/json"
|
||
```
|
||
|
||
```javascript
|
||
const url = new URL(
|
||
"http://localhost/api/ping"
|
||
);
|
||
|
||
let headers = {
|
||
"Content-Type": "application/json",
|
||
"Accept": "application/json",
|
||
};
|
||
|
||
|
||
fetch(url, {
|
||
method: "GET",
|
||
headers,
|
||
}).then(response => response.json());
|
||
```
|
||
|
||
```php
|
||
|
||
$client = new \GuzzleHttp\Client();
|
||
$response = $client->get(
|
||
'http://localhost/api/ping',
|
||
[
|
||
'headers' => [
|
||
'Content-Type' => 'application/json',
|
||
'Accept' => 'application/json',
|
||
],
|
||
]
|
||
);
|
||
$body = $response->getBody();
|
||
print_r(json_decode((string) $body));
|
||
```
|
||
|
||
|
||
> Example response (200):
|
||
|
||
```json
|
||
{
|
||
"status": "ok",
|
||
"timestamp": "2020-12-30T20:48:32.889955Z",
|
||
"host": "127.0.0.1"
|
||
}
|
||
```
|
||
<div id="execution-results-GETapi-ping" hidden>
|
||
<blockquote>Received response<span id="execution-response-status-GETapi-ping"></span>:</blockquote>
|
||
<pre class="json"><code id="execution-response-content-GETapi-ping"></code></pre>
|
||
</div>
|
||
<div id="execution-error-GETapi-ping" hidden>
|
||
<blockquote>Request failed with error:</blockquote>
|
||
<pre><code id="execution-error-message-GETapi-ping"></code></pre>
|
||
</div>
|
||
<form id="form-GETapi-ping" data-method="GET" data-path="api/ping" data-authed="0" data-hasfiles="0" data-headers='{"Content-Type":"application\/json","Accept":"application\/json"}' onsubmit="event.preventDefault(); executeTryOut('GETapi-ping', this);">
|
||
<h3>
|
||
Request
|
||
</h3>
|
||
<p>
|
||
<small class="badge badge-green">GET</small>
|
||
<b><code>api/ping</code></b>
|
||
</p>
|
||
</form>
|
||
|
||
|
||
## api/assets/{uuid}/render
|
||
|
||
|
||
|
||
|
||
> Example request:
|
||
|
||
```bash
|
||
curl -X GET \
|
||
-G "http://localhost/api/assets/libero/render" \
|
||
-H "Content-Type: application/json" \
|
||
-H "Accept: application/json"
|
||
```
|
||
|
||
```javascript
|
||
const url = new URL(
|
||
"http://localhost/api/assets/libero/render"
|
||
);
|
||
|
||
let headers = {
|
||
"Content-Type": "application/json",
|
||
"Accept": "application/json",
|
||
};
|
||
|
||
|
||
fetch(url, {
|
||
method: "GET",
|
||
headers,
|
||
}).then(response => response.json());
|
||
```
|
||
|
||
```php
|
||
|
||
$client = new \GuzzleHttp\Client();
|
||
$response = $client->get(
|
||
'http://localhost/api/assets/libero/render',
|
||
[
|
||
'headers' => [
|
||
'Content-Type' => 'application/json',
|
||
'Accept' => 'application/json',
|
||
],
|
||
]
|
||
);
|
||
$body = $response->getBody();
|
||
print_r(json_decode((string) $body));
|
||
```
|
||
|
||
|
||
> Example response (200):
|
||
|
||
```json
|
||
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD> |