Egon Elbre cafa7a5f0b satellite/admin: add a readme about endpoints

Change-Id: I720fcdf6af3860ad4c8566de85c39e9f06f7cb01

2020-04-28 19:13:45 +00:00

1.1 KiB

Raw Blame History

satellite/admin

Satellite Admin package provides API endpoints for administrative tasks.

Requires setting Authorization header for requests.

GET /api/user/{user-email}

This endpoint returns information about user and their projects.

A successful response:

{
    "user":{
        "id": "12345678-1234-1234-1234-123456789abc",
        "fullName": "Alice Bob",
        "email":"alice@example.test"
    },
    "projects":[
        {
            "id": "abcabcab-1234-abcd-abcd-abecdefedcab",
            "name": "Project",
            "description": "Project to store data.",
            "ownerId": "12345678-1234-1234-1234-123456789abc"
        }
    ]
}

GET /api/project/{project-id}/limit

This endpoint returns information about project limits.

A successful response:

{
    "usage": {
        "amount":"0 B",
        "bytes":0
    },
    "rate":{
        "rps":0
    }
}

POST /api/project/{project-id}/limit?usage={value}

Updates usage limit for a project.

POST /api/project/{project-id}/limit?rate={value}

Updates rate limit for a project.

1.1 KiB Raw Blame History