# Initialize the resumable user import

`POST /api/v1/users/{userId}/imports/import-resumable`

**PeerTube >= 6.1** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the import of the archive

Authentication (security requirement alternatives):

```json
[
  {
    "OAuth2": []
  }
]
```

- 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


Parameters:

- `userId` (path, id, required) - User id
  Type: id
  
  Schema: [id](https://sourcey-peertube.pages.dev/api-rest-reference/models/id.md)
  
  minimum: 1
  
  Example:
  
  ```json
  42
  ```

- `X-Upload-Content-Length` (header, number, required) - Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.
  Type: number
  
  Example:
  
  ```json
  2469036
  ```

- `X-Upload-Content-Type` (header, string, mimetype, required) - MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.
  Type: string, mimetype
  
  Example:
  
  ```json
  "video/mp4"
  ```

Request body: application/json

Type: UserImportResumable

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

- `filename` (optional)
  Type: string, filename
  
  Archive filename including extension
  
  Example:
  
  ```json
  "user-export-6-2024-02-09T10_12_11.682Z"
  ```

Responses:

- 201: created

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/imports/import-resumable' \
  -H 'X-Upload-Content-Length: 2469036' \
  -H 'X-Upload-Content-Type: video/mp4' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}'
```

### JavaScript

```javascript
const body = `{
  "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/users/42/imports/import-resumable', {
  method: 'POST',
  headers: {
    'X-Upload-Content-Length': '2469036',
    'X-Upload-Content-Type': 'video/mp4',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

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

### Python

```python
import requests

body = '''{
  "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/users/42/imports/import-resumable',
    data=body.encode('utf-8'),
    headers={
        'X-Upload-Content-Length': '2469036',
        'X-Upload-Content-Type': 'video/mp4',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)
```