# Get a plugin

`GET /api/v1/plugins/{npmName}`

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"
  ```

Responses:

- 200: successful operation

Content type: application/json

Type: Plugin

Schema: [Plugin](https://sourcey-peertube.pages.dev/api-rest-reference/models/plugin.md)

- `name` (optional)
  Type: string
  
  Example:
  
  ```json
  "peertube-plugin-auth-ldap"
  ```

- `type` (optional)
  Type: integer
  
  - `1`: PLUGIN
  - `2`: THEME
  
  
  enum: [1,2]

- `latestVersion` (optional)
  Type: string
  
  Example:
  
  ```json
  "0.0.3"
  ```

- `version` (optional)
  Type: string
  
  Example:
  
  ```json
  "0.0.1"
  ```

- `enabled` (optional)
  Type: boolean

- `uninstalled` (optional)
  Type: boolean

- `peertubeEngine` (optional)
  Type: string
  
  Example:
  
  ```json
  "2.2.0"
  ```

- `description` (optional)
  Type: string

- `homepage` (optional)
  Type: string, url
  
  Example:
  
  ```json
  "https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap"
  ```

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

- `createdAt` (optional)
  Type: string, date-time

- `updatedAt` (optional)
  Type: string, date-time

- 404: plugin not found

## Examples

### cURL

```bash
curl -X GET 'https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap' \
  -H 'Authorization: Bearer YOUR_TOKEN'
```

### JavaScript

```javascript
const response = await fetch('https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

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

### Python

```python
import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)
```