Team quota

This section contains endpoints for flexible team quota management.

Get quotas

GET {{BASE_URL}}/admin/api/team-quotas

Get all quotas that are set for a specific team.

Path Parameters

NameTypeDescription

id*

String

App ID

Query Parameters

NameTypeDescription

page*

String

1

limit*

String

5

Headers

NameTypeDescription

Api-Key*

String

Admin api key

{
    "docs": [
        {
            "_id": "6548a41f38406c14db33b61e",
            "name": "My Team",
            "email": "john.doe@mail.com",
            "members": [
                {
                    "user": {
                        "_id": "6548a41138406c14db33b606",
                        "name": "John Doe",
                        "email": "john.doe@mail.com"
                    },
                    "role": 0
                }
            ],
            "createdAt": "2023-11-06T08:30:23.529Z",
            "updatedAt": "2023-11-06T12:56:06.337Z",
            "billingSettings": "6548e2660919dc0442dc2ec7",
            "quotas": [
                {
                    "_id": "6548a41f38406c14db33b624",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9681",
                        "name": "Azure",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 4,
                    "k8s": {
                        "masterNode": 2,
                        "workerNode": 2
                    },
                    "createdAt": "2023-11-06T08:27:47.146Z",
                    "updatedAt": "2023-11-06T08:27:47.146Z",
                    "team": "6548a41f38406c14db33b61e"
                },
                {
                    "_id": "6548a41f38406c14db33b625",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9682",
                        "name": "AWS",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 4,
                    "k8s": {
                        "masterNode": 2,
                        "workerNode": 2
                    },
                    "createdAt": "2023-11-06T08:27:47.146Z",
                    "updatedAt": "2023-11-06T08:27:47.146Z",
                    "team": "6548a41f38406c14db33b61e"
                },
                {
                    "_id": "6548a41f38406c14db33b626",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9683",
                        "name": "GCP",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 4,
                    "k8s": {
                        "masterNode": 2,
                        "workerNode": 2
                    },
                    "createdAt": "2023-11-06T08:27:47.146Z",
                    "updatedAt": "2023-11-06T08:27:47.146Z",
                    "team": "6548a41f38406c14db33b61e"
                },
                {
                    "_id": "6548a41f38406c14db33b627",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9684",
                        "name": "OVH",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 4,
                    "k8s": {
                        "masterNode": 2,
                        "workerNode": 2
                    },
                    "createdAt": "2023-11-06T08:27:47.146Z",
                    "updatedAt": "2023-11-06T08:27:47.146Z",
                    "team": "6548a41f38406c14db33b61e"
                },
                {
                    "_id": "6548a41f38406c14db33b628",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9685",
                        "name": "Kraud.Cloud",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 4,
                        "gitlab": 4
                    },
                    "databases": {
                        "mongo": 4,
                        "postgres": 4,
                        "maria": 4,
                        "redis": 4
                    },
                    "vm": 4,
                    "k8s": {
                        "masterNode": 2,
                        "workerNode": 2
                    },
                    "createdAt": "2023-11-06T08:27:47.146Z",
                    "updatedAt": "2023-11-06T08:27:47.146Z",
                    "team": "6548a41f38406c14db33b61e"
                }
            ],
            "id": "6548a41f38406c14db33b61e",
            "usages": [
                {
                    "_id": "4934d760-d66d-4b22-9277-2a2c5fcb57ff",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9681",
                        "name": "Azure",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 0,
                    "k8s": {
                        "masterNode": 0,
                        "workerNode": 0
                    }
                },
                {
                    "_id": "fbfd39de-37c7-4d1c-a2a2-424a3b4a7cca",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9682",
                        "name": "AWS",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 0,
                    "k8s": {
                        "masterNode": 0,
                        "workerNode": 0
                    }
                },
                {
                    "_id": "8078d6de-0361-4423-bd8a-22fd995eb03d",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9683",
                        "name": "GCP",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 0,
                    "k8s": {
                        "masterNode": 0,
                        "workerNode": 0
                    }
                },
                {
                    "_id": "fc7f63fd-7ce1-4ca6-a6af-b9f8c5d77345",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9684",
                        "name": "OVH",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 0,
                    "k8s": {
                        "masterNode": 0,
                        "workerNode": 0
                    }
                },
                {
                    "_id": "6c174df6-b9ff-47ec-a72f-0a5b88e82b33",
                    "cloudProvider": {
                        "_id": "6548a383e2442d14b6bf9685",
                        "name": "Kraud.Cloud",
                        "isDisabled": false
                    },
                    "apps": {
                        "nextCloud": 0,
                        "gitlab": 0
                    },
                    "databases": {
                        "mongo": 0,
                        "postgres": 0,
                        "maria": 0,
                        "redis": 0
                    },
                    "vm": 0,
                    "k8s": {
                        "masterNode": 0,
                        "workerNode": 0
                    }
                }
            ]
        }
    ],
    "totalDocs": 3,
    "limit": 1,
    "totalPages": 3,
    "page": 1,
    "pagingCounter": 1,
    "hasPrevPage": false,
    "hasNextPage": true,
    "prevPage": null,
    "nextPage": 2
}

Update quotas

PUT {{BASE_URL}}/admin/api/team-quotas/{id}

Update team quotas by unique id.

Path Parameters

NameTypeDescription

id*

String

Quota ID

Headers

NameTypeDescription

Api-Key*

String

Admin api key

Request Body

NameTypeDescription

data*

Object

{
    "apps": {
        "nextCloud": 0,
        "gitlab": 0
    },
    "databases": {
        "mongo": 0,
        "postgres": 0,
        "maria": 0,
        "redis": 0
    },
    "k8s": {
        "masterNode": 1,
        "workerNode": 2
    },
    "_id": "6548a41f38406c14db33b624",
    "cloudProvider": {
        "_id": "6548a383e2442d14b6bf9681",
        "name": "Azure",
        "isDisabled": false
    },
    "vm": 4,
    "createdAt": "2023-11-06T08:27:47.146Z",
    "updatedAt": "2023-11-07T13:23:27.213Z",
    "team": "6548a41f38406c14db33b61e"
}
Request payload
{
    "vm": 4,
    "k8s": {
        "masterNode": 1,
        "workerNode": 2
    },
    "apps": {
        "nextCloud": 0,
        "gitlab": 0
    },
    "databases": {
        "mongo": 0,
        "postgres": 0,
        "maria": 0,
        "redis": 0
    }
}

Last updated