{ "opencollection": "1.0.0", "info": { "name": "Bluesky Social Actor Profiles Server API", "version": "1.0.0" }, "items": [ { "info": { "name": "Server", "type": "folder" }, "items": [ { "info": { "name": "Bluesky Activates a currently deactivated account.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.activateAccount", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nActivates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup." }, { "info": { "name": "Bluesky Returns the status of an account, especially as pertaining to import or recovery.", "type": "http" }, "http": { "method": "GET", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.checkAccountStatus", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nReturns 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 pe" }, { "info": { "name": "Bluesky Confirm an email using a token from com.atproto.server.requestEmailConfirmation.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.confirmEmail", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nConfirm an email using a token from com.atproto.server.requestEmailConfirmation." }, { "info": { "name": "Bluesky Create an account.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.createAccount", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nCreate an account. Implemented by PDS." }, { "info": { "name": "Bluesky Create an App Password.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.createAppPassword", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nCreate an App Password." }, { "info": { "name": "Bluesky Create an invite code.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.createInviteCode", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nCreate an invite code." }, { "info": { "name": "Bluesky Create invite codes.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.createInviteCodes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nCreate invite codes." }, { "info": { "name": "Bluesky Create an authentication session.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.createSession", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nCreate an authentication session." }, { "info": { "name": "Bluesky Deactivates a currently active account.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.deactivateAccount", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nDeactivates 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" }, { "info": { "name": "Bluesky Delete an actor's account with a token and password.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.deleteAccount", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nDelete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth." }, { "info": { "name": "Bluesky Delete the current session.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.deleteSession", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nDelete the current session. Requires auth." }, { "info": { "name": "Bluesky Describes the server's account creation requirements and capabilities.", "type": "http" }, "http": { "method": "GET", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.describeServer", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nDescribes the server's account creation requirements and capabilities. Implemented by PDS." }, { "info": { "name": "Bluesky Get all invite codes for the current account.", "type": "http" }, "http": { "method": "GET", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.getAccountInviteCodes", "params": [ { "name": "includeUsed", "value": "true", "type": "query" }, { "name": "createAvailable", "value": "true", "type": "query", "description": "Controls whether any new 'earned' but not 'created' invites should be created." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nGet all invite codes for the current account. Requires auth." }, { "info": { "name": "Bluesky Get a signed token on behalf of the requesting DID for the requested service.", "type": "http" }, "http": { "method": "GET", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.getServiceAuth", "params": [ { "name": "aud", "value": "did:plc:example123abc", "type": "query", "description": "The DID of the service that the token will be used to authenticate with" }, { "name": "exp", "value": "50", "type": "query", "description": "The time in Unix Epoch seconds that the JWT expires. Defaults to 60 seconds in the future. The service may enforce certain time bounds on tokens depending on the requested scope." }, { "name": "lxm", "value": "app.bsky.feed.post", "type": "query", "description": "Lexicon (XRPC) method to bind the requested token to" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nGet a signed token on behalf of the requesting DID for the requested service." }, { "info": { "name": "Bluesky Get information about the current auth session.", "type": "http" }, "http": { "method": "GET", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.getSession", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nGet information about the current auth session. Requires auth." }, { "info": { "name": "Bluesky List all App Passwords.", "type": "http" }, "http": { "method": "GET", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.listAppPasswords", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nList all App Passwords." }, { "info": { "name": "Bluesky Refresh an authentication session.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.refreshSession", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nRefresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt')." }, { "info": { "name": "Bluesky Initiate a user account deletion via email.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.requestAccountDelete", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nInitiate a user account deletion via email." }, { "info": { "name": "Bluesky Request an email with a code to confirm ownership of email.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.requestEmailConfirmation", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nRequest an email with a code to confirm ownership of email." }, { "info": { "name": "Bluesky Request a token in order to update email.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.requestEmailUpdate", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nRequest a token in order to update email." }, { "info": { "name": "Bluesky Initiate a user account password reset via email.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.requestPasswordReset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nInitiate a user account password reset via email." }, { "info": { "name": "Bluesky Reserve a repo signing key, for use with account creation.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.reserveSigningKey", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nReserve 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; i" }, { "info": { "name": "Bluesky Reset a user account password using a token.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.resetPassword", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nReset a user account password using a token." }, { "info": { "name": "Bluesky Revoke an App Password by name.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.revokeAppPassword", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nRevoke an App Password by name." }, { "info": { "name": "Bluesky Update an account's email.", "type": "http" }, "http": { "method": "POST", "url": "https://bsky.social/xrpc/xrpc/com.atproto.server.updateEmail", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "*This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.*\n\n*To learn more about calling atproto API endpoints like this one, see the [API Hosts and Auth](/docs/advanced-guides/api-directory) guide.*\n\nUpdate an account's email." } ] } ], "bundled": true }