REST - Grupy

Listowanie grup

Zapytanie

POST /v2/groups

Zwraca tablicę z listą istniejących grup.

Odpowiedź

{
    "success":true,
    "groups":[
        {
            "id":"$group_id",
            "name":"$group_name",
            "owner":{
                "id":"$owner_id",
                "name":"$owner_name",
            },
            "members":[
            
            ],
            "virtual_machines":[
            
            ],
            "permisions":{
                "global":[
                
                ],
                "vm":[
                
                ]
            }
        }, { ... }
    ]
}

Zwracane informacje

• $group_id (string) - UUID grupy
• $group_name (string) - nazwa grupy
• $owner_id (string) - UUID właściciela grupy
• $owner_name (string) - nazwa właściciela grupy

Pobieranie informacji o grupie

Zapytanie

POST /v2/groups/$GROUP_ID

Zwraca informacje o pojedynczej grupie o podanym $GROUP_ID.

Odpowiedź

{
    "success":true,
    "group":
    {
        "id":"$group_id",
        "name":"$group_name",
        "owner":{
            "id":"$owner_id",
            "name":"$owner_name",
        },
        "members":[
        
        ],
        "virtual_machines":[
        
        ],
        "permisions":{
            "global":[
            
            ],
            "vm":[
            
            ]
        }
    }
}

Zwracane informacje

• $group_id (string) - UUID grupy
• $group_name (string) - nazwa grupy
• $owner_id (string) - UUID właściciela grupy
• $owner_name (string) - nazwa właściciela grupy

Dodanie użytkownika do grupy

Zapytanie

POST /v2/groups/$GROUP_ID/group-attach-user

Dodaje użytkownika do grupy o podanym $GROUP_ID.

Zawartość zapytania

{ 
  "id" : $user_id
}

Opis parametrów

• $user_id (string) - UUID użytkownika

Odpowiedź

{  
  "success":true
}

Dodanie serwera do grupy

Zapytanie

POST /v2/groups/$GROUP_ID/group-attach-vm

Dodaje serwer z grupy o podanym $GROUP_ID.

Zawartość zapytania

{ 
  "id" : $vm_id
}

Opis parametrów

• $vm_id (string) - UUID serwera

Odpowiedź

{  
  "success":true
}

Odłączenie użytkownika do grupy

Zapytanie

POST /v2/groups/$GROUP_ID/group-detach-user

Dodaje zadanie usunięcia użytkownika z grupy o podanym $GROUP_ID.

Zawartość zapytania

{ 
  "id" : $user_id
}

Opis parametrów

• $user_id (string) - UUID użytkownika

Odpowiedź

{  
  "success":true
}

Odłączenie serwera do grupy

Zapytanie

POST /v2/groups/$GROUP_ID/group-detach-vm

Dodaje zadanie usunięcia serwera z grupy o podanym $GROUP_ID.

Zawartość zapytania

{ 
  "id" : $vm_id
}

Opis parametrów

• $vm_id (string) - UUID serwera

Odpowiedź

{  
  "success":true
}

Usunięcie grupy

Zapytanie

DELETE  /v2/groups/$GROUP_ID

Dodaje zadanie usunięcia grupy o podanym $GROUP_ID.

Odpowiedź

{  
  "success":true
}

Updated on 05 Sep 2023