com.atproto.repo.describeRepo
GET/xrpc/com.atproto.repo.describeRepo
This endpoint is part of the atproto PDS repository management APIs. Requests usually require authentication (unlike the com.atproto.sync.*
endpoints), and are made directly to the user's own PDS instance.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Get information about an account and repository, including the list of collections. Does not require auth.
Request
Query Parameters
repo at-identifierrequired
The handle or DID of the repo.
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
handle handlerequired
did didrequired
didDoc required
collections nsid[]required
handleIsCorrect booleanrequired
Indicates if handle is currently valid (resolves bi-directionally)
{
"handle": "string",
"did": "string",
"didDoc": {},
"collections": [
"string"
],
"handleIsCorrect": true
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
error stringrequired
Possible values: [InvalidRequest
, ExpiredToken
, InvalidToken
]
message stringrequired
{
"error": "InvalidRequest",
"message": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
error required
message stringrequired
{
"message": "string"
}
Loading...