# Update a plugin

`POST /api/v1/plugins/update`

Authentication (security requirement alternatives):

```json
[
  {
    "OAuth2": [
      "admin"
    ]
  }
]
```

- OAuth2: oauth2. Authenticating via OAuth requires the following steps:
- Have an activated account
- [Generate] an access token for that account at `/api/v1/users/token`.
- Make requests with the *Authorization: Bearer <token\>* header
- Profit, depending on the role assigned to the account

Note that the __access token is valid for 1 day__ and is given
along with a __refresh token valid for 2 weeks__.

[Generate]: https://docs.joinpeertube.org/api/rest-getting-started
; scopes: admin

Request body: application/json

Type: object

oneOf:
  Type: object
  
  - `npmName` (required)
    Type: string
    
    Example:
    
    ```json
    "peertube-plugin-auth-ldap"
    ```
  
  - `currentPassword` (optional)
    Reference: [currentPassword](https://sourcey-peertube.pages.dev/api-rest-reference/models/currentpassword.md); Type: currentPassword, password
    
    Password of the authenticated user, required if [password confirmation](#section/Password-confirmation) is enabled
  
  Additional properties: false

  Type: object
  
  - `path` (required)
    Type: string
  
  - `currentPassword` (optional)
    Reference: [currentPassword](https://sourcey-peertube.pages.dev/api-rest-reference/models/currentpassword.md); Type: currentPassword, password
    
    Password of the authenticated user, required if [password confirmation](#section/Password-confirmation) is enabled
  
  Additional properties: false

Responses:

- 204: successful operation

- 400: should have either `npmName` or `path` set, or `currentPassword` is missing

- 403: invalid `currentPassword`, or password confirmation unavailable for this user

- 404: existing plugin not found

- 429: too many failed password confirmations

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/plugins/update' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "npmName": "peertube-plugin-auth-ldap",
  "currentPassword": "********"
}'
```

### JavaScript

```javascript
const body = `{
  "npmName": "peertube-plugin-auth-ldap",
  "currentPassword": "********"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/plugins/update', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();
```

### Python

```python
import requests

body = '''{
  "npmName": "peertube-plugin-auth-ldap",
  "currentPassword": "********"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/plugins/update',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)
```