# Register a new runner

`POST /api/v1/runners/register`

API used by PeerTube runners

Authentication: no security requirement declared for this operation.

Request body: application/json

Type: object

- `registrationToken` (required)
  Type: string

- `name` (required)
  Type: string

- `description` (optional)
  Type: string

Responses:

- 200: successful operation

Content type: application/json

Type: object

- `id` (optional)
  Type: integer
  
  Runner id

- `runnerToken` (optional)
  Type: string

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/runners/register' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "registrationToken": "string",
  "name": "string",
  "description": "string"
}'
```

### JavaScript

```javascript
const body = `{
  "registrationToken": "string",
  "name": "string",
  "description": "string"
}`;

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

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

### Python

```python
import requests

body = '''{
  "registrationToken": "string",
  "name": "string",
  "description": "string"
}'''

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