Request registration

POST

https://peertube2.cpy.re/api/v1/users/registrations/request

Signup has to be enabled and require approval on the instance

curl -X POST 'https://peertube2.cpy.re/api/v1/users/registrations/request' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "password": "********",
  "email": "user@example.com",
  "displayName": "string",
  "channel": {
    "name": "framasoft_videos",
    "displayName": "string"
  },
  "signupClient": "peertube-app",
  "registrationReason": "string"
}'

const body = `{
  "password": "********",
  "email": "user@example.com",
  "displayName": "string",
  "channel": {
    "name": "framasoft_videos",
    "displayName": "string"
  },
  "signupClient": "peertube-app",
  "registrationReason": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "password": "********",
  "email": "user@example.com",
  "displayName": "string",
  "channel": {
    "name": "framasoft_videos",
    "displayName": "string"
  },
  "signupClient": "peertube-app",
  "registrationReason": "string"
}'''

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

Request Body

{
  "password": "********",
  "email": "user@example.com",
  "displayName": "string",
  "channel": {
    "name": "framasoft_videos",
    "displayName": "string"
  },
  "signupClient": "peertube-app",
  "registrationReason": "string"
}

200

{
  "state": {
    "id": 1,
    "label": "string"
  }
}

Body

application/json

usernameusernamerequired

immutable name of the user, used to find or mention its actor

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

passwordpassword<password>required

emailstring<email>required

email of the user, used for login or service communications

displayNamestring

editable name of the user, displayed in its representations

channelobject

channel base information used to create the first channel of the user

Show child attributes

nameusernameChannel

immutable name of the channel, used to interact with its actor

Example

framasoft_videos

displayNamestring

signupClientstringpeertube-app

PeerTube >= 9.0 Client used to sign up. If set, links of the verification and registration accepted emails make the web client propose to open this client

registrationReasonstringrequired

reason for the user to register on the instance

Response

200OKobject

successful operation

Response fields application/json

stateobject

Show child attributes

idUserRegistrationState123

The registration state (Pending = 1, Rejected = 2, Accepted = 3)

labelstring

400Bad Request

request error or signup approval is not enabled on the instance

403Forbidden

user registration is not enabled, user limit is reached, registration is not allowed for the ip or blocked by a plugin

409Conflict

a user or registration with this username, channel name or email already exists

Docs by Sourcey