1.8 KiB
1.8 KiB
title |
---|
paste.sr.ht API reference |
API Reference
The paste.sr.ht API allows you to browse and create pastes on paste.sr.ht programmatically. This API follows the standard sourcehut API conventions.
Authentication
Authentication is done via the meta.sr.ht OAuth flow. The following OAuth scopes are available for paste.sr.ht:
- paste:read, paste:write: read & write paste resources
Resources
Paste resource
{
"created": "timestamp",
"sha": "id of this paste (SHA-1 hash)",
"user": { short-form user resource },
"files": [
{
"filename": "filename" or null,
"blob_id": "id of this blob (SHA-1 hash)"
}, ...
]
}
Blob resource
{
"created": "timestamp",
"sha": "id of this blob (SHA-1 hash)",
"contents": "contents of this blob"
}
Endpoints
GET /api/pastes
List of paste resources.
OAuth scope: pastes:read
POST /api/pastes
Create a new paste resource.
OAuth scope: pastes:write
Request body
{
"files": [
{
"filename": "filename" or null, (optional)
"contents": "contents of this file"
}
]
}
- contents must be a UTF-8 encoded string; binary files are not allowed
Response
The new paste resource.
GET /api/pastes/:sha
Retrieves a paste resource.
OAuth scope: pastes:read
GET /api/blobs/:sha
Retrieves a blob resource.
OAuth scope: pastes:read
Webhooks
/api/pastes/...
Webhook for paste events. Includes the standard webhook endpoints
paste:create
Issued when a new paste is created.
OAuth scope: paste:read
Request body
Affected paste resource.