# Pause job queue

`POST /api/v1/jobs/pause`

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

- `processRoles` (optional)
  Type: Array<string>
  
  Roles of the PeerTube processes that must pause their job queue. Defaults to all the roles. Other processes are notified asynchronously.
  
  minItems: 1
  
  Items:
    Type: string
    
    enum: ["primary","secondary"]

Responses:

- 204: successful operation

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/jobs/pause' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "processRoles": [
    "primary"
  ]
}'
```

### JavaScript

```javascript
const body = `{
  "processRoles": [
    "primary"
  ]
}`;

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

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

### Python

```python
import requests

body = '''{
  "processRoles": [
    "primary"
  ]
}'''

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