2023-05-22 17:12:17 +02:00
|
|
|
# Other Requests
|
|
|
|
|
2023-05-22 17:18:26 +02:00
|
|
|
The universal Aquarius Endpoint is [`https://v4.aquarius.oceanprotocol.com`](https://v4.aquarius.oceanprotocol.com).
|
|
|
|
|
2023-05-23 20:12:14 +02:00
|
|
|
### **Info**
|
|
|
|
|
|
|
|
GET `/`
|
2023-05-22 17:18:26 +02:00
|
|
|
|
|
|
|
#### Description
|
|
|
|
|
|
|
|
Get version, plugin, and software information.
|
|
|
|
|
|
|
|
#### Curl Example
|
|
|
|
|
|
|
|
```bash
|
|
|
|
curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/'
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Javascript Example
|
|
|
|
|
|
|
|
```runkit nodeVersion="18.x.x"
|
|
|
|
const axios = require('axios')
|
|
|
|
|
|
|
|
const response = await axios( 'https://v4.aquarius.oceanprotocol.com/')
|
|
|
|
console.log(response.status)
|
|
|
|
console.log(response.data)
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
|
|
`200`
|
|
|
|
|
|
|
|
Description: Successful request
|
|
|
|
|
|
|
|
Body:
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
"plugin": "elasticsearch",
|
|
|
|
"software": "Aquarius",
|
|
|
|
"version": "4.2.0"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2023-05-23 20:12:14 +02:00
|
|
|
### **Health**
|
|
|
|
|
|
|
|
GET `/health`
|
2023-05-22 17:18:26 +02:00
|
|
|
|
|
|
|
**Description**
|
|
|
|
|
|
|
|
Get health status
|
|
|
|
|
|
|
|
**Curl Example**
|
|
|
|
|
|
|
|
```bash
|
|
|
|
curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/health'
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Javascript Example
|
|
|
|
|
|
|
|
```runkit nodeVersion="18.x.x"
|
|
|
|
const axios = require('axios')
|
|
|
|
|
|
|
|
const response = await axios( 'https://v4.aquarius.oceanprotocol.com/health')
|
|
|
|
console.log(response.status)
|
|
|
|
console.log(response.data)
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
**Response**
|
|
|
|
|
|
|
|
`200`
|
|
|
|
|
|
|
|
Description: Successful request
|
|
|
|
|
|
|
|
Body:
|
|
|
|
|
|
|
|
```
|
|
|
|
Elasticsearch connected
|
|
|
|
```
|
|
|
|
|
2023-05-23 20:12:14 +02:00
|
|
|
### **Spec**
|
|
|
|
|
|
|
|
GET /spec
|
2023-05-22 17:18:26 +02:00
|
|
|
|
|
|
|
#### Description
|
|
|
|
|
|
|
|
Get swagger spec
|
|
|
|
|
|
|
|
#### Example
|
|
|
|
|
|
|
|
```bash
|
|
|
|
curl --location --request GET 'https://v4.aquarius.oceanprotocol.com/spec'
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Javascript Example
|
|
|
|
|
|
|
|
```runkit nodeVersion="18.x.x"
|
|
|
|
const axios = require('axios')
|
|
|
|
|
|
|
|
const response = await axios( 'https://v4.aquarius.oceanprotocol.com/spec')
|
|
|
|
console.log(response.status)
|
|
|
|
console.log(response.data.info)
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
|
|
`200`
|
|
|
|
|
2023-05-23 20:12:14 +02:00
|
|
|
Successful request
|