# List jobs

`GET /api/v1/runners/jobs`

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:

- `start` (query, integer, optional) - Offset used to paginate results
  Type: integer
  
  minimum: 0

- `count` (query, integer, optional) - Number of items to return
  Type: integer
  
  default: 15
  
  minimum: 1
  
  maximum: 100

- `sort` (query, string, optional) - Sort runner jobs by criteria
  Type: string
  
  enum: ["updatedAt","createdAt","priority","state","progress"]

- `search` (query, string, optional) - Plain text search, applied to various parts of the model depending on endpoint
  Type: string

- `stateOneOf` (query, Array<RunnerJobState>, optional)
  Type: Array<RunnerJobState>
  
  Items:
    Reference: [RunnerJobState](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobstate.md); Type: RunnerJobState
    
    The runner job state:
      - `1` Pending
      - `2` Processing
      - `3` Completed
      - `4` Errored
      - `5` Waiting for a parent job
      - `6` Cancelled
      - `7` Parent had an error
      - `8` Parent has been cancelled
    
    
    enum: [1,2,3,4,5,6,7,8]

- `typeOneOf` (query, Array<RunnerJobType>, optional)
  Type: Array<RunnerJobType>
  
  Items:
    Reference: [RunnerJobType](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobtype.md); Type: RunnerJobType
    
    enum: ["vod-web-video-transcoding","vod-hls-transcoding","vod-audio-merge-transcoding","live-rtmp-hls-transcoding"]

Responses:

- 200: successful operation

Content type: application/json

Type: object

- `total` (optional)
  Type: integer
  
  Example:
  
  ```json
  1
  ```

- `data` (optional)
  Type: Array<RunnerJobAdmin>
  
  Items:
    Reference: [RunnerJobAdmin](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobadmin.md); Type: RunnerJob & object

## Examples

### cURL

```bash
curl -X GET 'https://peertube2.cpy.re/api/v1/runners/jobs?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'
```

### JavaScript

```javascript
const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs?count=15', {
  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/runners/jobs?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)
```