app.rocksky.mirror.putMirrorSource Documentation (EN)

main procedure

Upsert a mirror source for the authenticated user. Toggling `enabled` notifies the mirror process over NATS so it can start/stop the per-user task without a restart.

Input

Encodingapplication/json

apiKey string Optional

API key / token to be encrypted at rest. Omit to leave the existing key unchanged. Pass an empty string to clear it.

enabled boolean Optional

Enable or disable mirroring for this provider.

externalUsername string Optional

External username (Last.fm / ListenBrainz). Required when enabling those providers. Ignored for Teal.fm.

provider string Required

One of: lastfm, listenbrainz, tealfm

Output

Encodingapplication/json

Schemaapp.rocksky.mirror.defs#mirrorSourceView

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "provider"
      ],
      "properties": {
        "apiKey": {
          "type": "string",
          "description": "API key / token to be encrypted at rest. Omit to leave the existing key unchanged. Pass an empty string to clear it."
        },
        "enabled": {
          "type": "boolean",
          "description": "Enable or disable mirroring for this provider."
        },
        "provider": {
          "type": "string",
          "description": "One of: lastfm, listenbrainz, tealfm"
        },
        "externalUsername": {
          "type": "string",
          "description": "External username (Last.fm / ListenBrainz). Required when enabling those providers. Ignored for Teal.fm."
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "ref": "app.rocksky.mirror.defs#mirrorSourceView",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "description": "Upsert a mirror source for the authenticated user. Toggling `enabled` notifies the mirror process over NATS so it can start/stop the per-user task without a restart."
}