Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

1. Create 

POST api/v1/agents/

For example, a k8s has been started in advance, and an agent is configured to connect to it. Then we register the agent's API URL to Cello.

Body ParametersTypeNote
namestring
typestring
urlsstring

Example Request Body

Code Block
{
    "name": "cello-agent-docker",
    "type": "docker",
    "urls": "http://cello.docker.agent:5001"
}

Example Response Body

Code Block
{
    "data": {
        "id": "64b4b978-03e7-4bcc-b0f7-4601eed71e47"
    },
    "msg": null,
    "status": "successful"
}


2. List

GET api/v1/agents/

List all agents with criteria

Body ParametersTypeNote
idUUID
name string
statusstring
create_atdate
typestring
urlsstring
organizationUUID

Example Response Body

Code Block
{
    "data": {
        "total": 1,
        "data": [
            {
                "id": "fe910cd9-e8fe-4af1-a184-077da69f36e0",
                "name": "cello-agent-docker",
                "status": "active",
                "created_at": "2021-12-17T02:44:48.006079Z",
                "type": "docker",
                "urls": "http://cello.docker.agent:5001",
                "organization": "c09e3be4-3bd4-4ae3-8b27-7e8e56c853de"
            }
        ]
    },
    "msg": null,
    "status": "successful"
}