- com.atproto.admin.defs defs
- com.atproto.admin.deleteAccount procedure Delete a user account as an administrator.
- com.atproto.admin.disableAccountInvites procedure Disable an account from receiving new invite codes, but does not invalidate existing codes.
- com.atproto.admin.disableInviteCodes procedure Disable some set of codes and/or all codes associated with a set of users.
- com.atproto.admin.enableAccountInvites procedure Re-enable an account's ability to receive invite codes.
- com.atproto.admin.getAccountInfo query Get details about an account.
- com.atproto.admin.getAccountInfos query Get details about some accounts.
- com.atproto.admin.getInviteCodes query Get an admin view of invite codes.
- com.atproto.admin.getSubjectStatus query Get the service-specific admin status of a subject (account, record, or blob).
- com.atproto.admin.searchAccounts query Get list of accounts that matches your search query.
- com.atproto.admin.sendEmail procedure Send email to a user's account email address.
- com.atproto.admin.updateAccountEmail procedure Administrative action to update an account's email.
- com.atproto.admin.updateAccountHandle procedure Administrative action to update an account's handle.
- com.atproto.admin.updateAccountPassword procedure Update the password for a user account as an administrator.
- com.atproto.admin.updateAccountSigningKey procedure Administrative action to update an account's signing key in their Did document.
- com.atproto.admin.updateSubjectStatus procedure Update the service-specific admin status of a subject (account, record, or blob).
- com.atproto.identity.defs defs
- com.atproto.identity.getRecommendedDidCredentials query Describe the credentials that should be included in the DID doc of an account that is migrating to this service.
- com.atproto.identity.refreshIdentity procedure Request that the server re-resolve an identity (DID and handle). The server may ignore this request, or require authentication, depending on the role, implementation, and policy of the server.
- com.atproto.identity.requestPlcOperationSignature procedure Request an email with a code to in order to request a signed PLC operation. Requires Auth.
- com.atproto.identity.resolveDid query Resolves DID to DID document. Does not bi-directionally verify handle.
- com.atproto.identity.resolveHandle query Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document.
- com.atproto.identity.resolveIdentity query Resolves an identity (DID or Handle) to a full identity (DID document and verified handle).
- com.atproto.identity.signPlcOperation procedure Signs a PLC operation to update some value(s) in the requesting DID's document.
- com.atproto.identity.submitPlcOperation procedure Validates a PLC operation to ensure that it doesn't violate a service's constraints or get the identity into a bad state, then submits it to the PLC registry
- com.atproto.identity.updateHandle procedure Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.
- com.atproto.label.defs defs Metadata tag on an atproto resource (eg, repo or record).
- com.atproto.label.queryLabels query Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.
- com.atproto.label.subscribeLabels subscription Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.
- com.atproto.lexicon.resolveLexicon query Resolves an atproto lexicon (NSID) to a schema.
- com.atproto.lexicon.schema record Representation of Lexicon schemas themselves, when published as atproto records. Note that the schema language is not defined in Lexicon; this meta schema currently only includes a single version field ('lexicon'). See the atproto specifications for description of the other expected top-level fields ('id', 'defs', etc).
- com.atproto.repo.applyWrites procedure Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.
- com.atproto.repo.createRecord procedure Create a single new repository record. Requires auth, implemented by PDS.
- com.atproto.repo.defs defs
- com.atproto.repo.deleteRecord procedure Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.
- com.atproto.repo.describeRepo query Get information about an account and repository, including the list of collections. Does not require auth.
- com.atproto.repo.getRecord query Get a single record from a repository. Does not require auth.
- com.atproto.repo.importRepo procedure Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.
- com.atproto.repo.listMissingBlobs query Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.
- com.atproto.repo.listRecords query List a range of records in a repository, matching a specific collection. Does not require auth.
- com.atproto.repo.putRecord procedure Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.
- com.atproto.repo.strongRef object A URI with a content-hash fingerprint.
- com.atproto.repo.uploadBlob procedure Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.
- com.atproto.server.activateAccount procedure Activates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup.
- com.atproto.server.checkAccountStatus query Returns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires auth and can only be called pertaining to oneself.
- com.atproto.server.confirmEmail procedure Confirm an email using a token from com.atproto.server.requestEmailConfirmation.
- com.atproto.server.createAccount procedure Create an account. Implemented by PDS.
- com.atproto.server.createAppPassword procedure Create an App Password.
- com.atproto.server.createInviteCode procedure Create an invite code.
- com.atproto.server.createInviteCodes procedure Create invite codes.
- com.atproto.server.createSession procedure Create an authentication session.
- com.atproto.server.deactivateAccount procedure Deactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old host after the account has been activated on the new host.
- com.atproto.server.defs defs
- com.atproto.server.deleteAccount procedure Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.
- com.atproto.server.deleteSession procedure Delete the current session. Requires auth using the 'refreshJwt' (not the 'accessJwt').
- com.atproto.server.describeServer query Describes the server's account creation requirements and capabilities. Implemented by PDS.
- com.atproto.server.getAccountInviteCodes query Get all invite codes for the current account. Requires auth.
- com.atproto.server.getServiceAuth query Get a signed token on behalf of the requesting DID for the requested service.
- com.atproto.server.getSession query Get information about the current auth session. Requires auth.
- com.atproto.server.listAppPasswords query List all App Passwords.
- com.atproto.server.refreshSession procedure Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').
- com.atproto.server.requestAccountDelete procedure Initiate a user account deletion via email.
- com.atproto.server.requestEmailConfirmation procedure Request an email with a code to confirm ownership of email.
- com.atproto.server.requestEmailUpdate procedure Request a token in order to update email.
- com.atproto.server.requestPasswordReset procedure Initiate a user account password reset via email.
- com.atproto.server.reserveSigningKey procedure Reserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public and does not require auth; implemented by PDS. NOTE: this endpoint may change when full account migration is implemented.
- com.atproto.server.resetPassword procedure Reset a user account password using a token.
- com.atproto.server.revokeAppPassword procedure Revoke an App Password by name.
- com.atproto.server.updateEmail procedure Update an account's email.
- com.atproto.sync.defs defs
- com.atproto.sync.getBlob query Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.
- com.atproto.sync.getBlocks query Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.
- com.atproto.sync.getCheckout query DEPRECATED - please use com.atproto.sync.getRepo instead
- com.atproto.sync.getHead query DEPRECATED - please use com.atproto.sync.getLatestCommit instead
- com.atproto.sync.getHostStatus query Returns information about a specified upstream host, as consumed by the server. Implemented by relays.
- com.atproto.sync.getLatestCommit query Get the current commit CID & revision of the specified repo. Does not require auth.
- com.atproto.sync.getRecord query Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.
- com.atproto.sync.getRepo query Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.
- com.atproto.sync.getRepoStatus query Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.
- com.atproto.sync.listBlobs query List blob CIDs for an account, since some repo revision. Does not require auth; implemented by PDS.
- com.atproto.sync.listHosts query Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays.
- com.atproto.sync.listRepos query Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.
- com.atproto.sync.listReposByCollection query Enumerates all the DIDs which have records with the given collection NSID.
- com.atproto.sync.notifyOfUpdate procedure Notify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling service to disconnect. Does not require auth; implemented by Relay. DEPRECATED: just use com.atproto.sync.requestCrawl
- com.atproto.sync.requestCrawl procedure Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.
- com.atproto.sync.subscribeRepos subscription Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.