# Set a plugin's settings

`PUT /api/v1/plugins/{npmName}/settings`

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

Parameters:

- `npmName` (path, string, required) - name of the plugin/theme on npmjs.com or in its package.json
  Type: string
  
  Example:
  
  ```json
  "peertube-plugin-auth-ldap"
  ```

Request body: application/json

Type: object

- `settings` (optional)
  Type: object
  
  Additional properties: true

Responses:

- 204: successful operation

- 404: plugin not found

## Examples

### cURL

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

### JavaScript

```javascript
const body = `{
  "settings": {}
}`;

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

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

### Python

```python
import requests

body = '''{
  "settings": {}
}'''

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