How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PeerTube Register API

As a visitor, you can use this API to open an account (if registrations are open onthat PeerTube instance). As an admin, you should use the dedicated [User creationAPI](#operation/addUser) instead.

PeerTube Register API is one of 54 APIs that PeerTube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Register. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 10 operations across 10 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 8.1.0.

Requests are made against 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re.

10 operations 10 paths 9 schemas 1 DELETE1 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.1.0
Base URL
https://{instance}/api/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

PeerTube Register API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 3 scopes.

  • 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…

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 1 DELETE, 1 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Register 10

As a visitor, you can use this API to open an account (if registrations are open on that PeerTube instance). As an admin, you should use the dedicated [User creation API](operatio…

POST
/api/v1/users/ask-send-verify-email
Resend user verification link
resendEmailToVerifyUser body → 204
POST
/api/v1/users/registrations/ask-send-verify-email
Resend verification link to registration request email
resendEmailToVerifyRegistration body → 204
POST
/api/v1/users/{id}/verify-email
Verify a user
verifyUser 1 param body → 204403404
POST
/api/v1/users/registrations/{registrationId}/verify-email
Verify a registration email
verifyRegistrationEmail 1 param body → 204403404
POST
/api/v1/users/register
Register a user
registerUser body → 200400403409
POST
/api/v1/users/registrations/request
Request registration
requestRegistration body → 200400403409
POST
/api/v1/users/registrations/{registrationId}/accept
Accept registration
acceptRegistration 1 param body → 204
POST
/api/v1/users/registrations/{registrationId}/reject
Reject registration
rejectRegistration 1 param body → 204
DELETE
/api/v1/users/registrations/{registrationId}
Delete registration
deleteRegistration 1 param → 204
GET
/api/v1/users/registrations
List registrations
listRegistrations 5 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserRegistration (13 properties), RegisterUser (5 properties), UserRegistrationAcceptOrReject (2 properties). Each schema is shown below with its type and property counts.

username
string
immutable name of the user, used to find or mention its actor
UserRegistration
object
13 properties
usernameChannel
string
immutable name of the channel, used to interact with its actor
UserRegistrationState
integer
The registration state (Pending = 1, Rejected = 2, Accepted = 3)
id
integer
password
string
UserRegistrationAcceptOrReject
object
2 properties 1 required
UserRegistrationRequest
RegisterUser
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-register-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
PeerTube Account Blocklist API
PeerTube Accounts API
PeerTube Automatic Tags API
PeerTube Channels Sync API
PeerTube Client Config API
PeerTube Config API
PeerTube Contact API
PeerTube Debug API
PeerTube Homepage API
PeerTube Instance Follows API
PeerTube Instance Redundancy API
Where this information came from

This is an independent, third-party profile of PeerTube Register API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.