Get the app's group and its peers
curl --request GET \
--url https://api.storiza.store/apps/{id}/group \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.storiza.store/apps/{id}/group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.storiza.store/apps/{id}/group"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "Group",
"data": {
"group": {
"id": "<string>",
"name": "<string>"
},
"members": [
{
"id": "<string>",
"name": "<string>",
"hostname": "<string>",
"state": "<string>"
}
]
}
}App groups
Get the app's group and its peers
The group this app belongs to, and every other app in it.
A group is one shared Docker network on one node. Members reach each other by hostname over it — http://<hostname>:<containerPort> — with no port published and nothing leaving the machine. That is the whole mechanism: membership of the network IS the grouping, so there is no firewall rule to get wrong.
hostname is therefore unique inside a group and only inside one; two apps in different groups may share one.
Returns group: null when the app is not in a group.
Required API key permission: apps:read
GET
/
apps
/
{id}
/
group
Get the app's group and its peers
curl --request GET \
--url https://api.storiza.store/apps/{id}/group \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.storiza.store/apps/{id}/group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.storiza.store/apps/{id}/group"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "Group",
"data": {
"group": {
"id": "<string>",
"name": "<string>"
},
"members": [
{
"id": "<string>",
"name": "<string>",
"hostname": "<string>",
"state": "<string>"
}
]
}
}Authorizations
An API key from the Storiza dashboard (API & Integrations), sent as Authorization: Bearer stz_….
Path Parameters
Was this page helpful?