PUT /platforms/:platform/agents/:vip_identity - Githubissues

eclipse-volttron / volttron-lib-web

Other

0 stars 4 forks source link

PUT /platforms/:platform/agents/:vip_identity #26

Open davidraker opened 2 years ago

davidraker commented 2 years ago

Upgrade an agent on the VOLTTRON platform.

Request:

Authorization: BEARER <jwt_token>
To upgrade from an uploaded wheel:
- Content Type: application/x-wheel+zip
- Content Length: <file_length>
- Body:
```
<file_contents>
```
To install from pip:
- Content Type: application/json
- Body:
```
{
    "pypi_name": "<pypi_name>"
}
```

Response:

With valid BEARER token on success: 204 No Content
With valid BEARER token on failure: 400 Bad Request
- Content Type: application/json
- Body:
```
{
    "error": "<Error Message>"
}
```
With invalid BEARER token: 401 Unauthorized Response:
With valid BEARER token on success: 200 OK
- Content Type: application/json
- Body:
```
{
    "<vip_identity>": "<uuid>"
}
```
With valid BEARER token on failure: 400 Bad Request
- Content Type: application/json
- Body:
```
{
    "error": "<Error Message>"
}
```
With invalid BEARER token: 401 Unauthorized

davidraker commented 2 years ago

This can be accomplished using the install_agent RPC method to the control service. See the documentation for that method on line 612 of volttron/platform/control.py.