← Todos los NIPs

NIP-86

API de gestión de relays

BorradorHTTP

Una API HTTP, en la misma dirección que el WebSocket del relay, que permite a su operador vetar pubkeys, permitir kinds y moderar eventos con llamadas JSON-RPC sencillas firmadas mediante NIP-98.

Estado
En uso, pero todavía puede cambiar.
Último cambio
24 sept 2026

Pruébalo

Edita el formulario o el JSON: ambos se mantienen sincronizados, la insignia indica si el resultado es válido y, al tocar cualquier campo, se explica qué hace.

Qué construir

Cómo se conectan las partes: Firma y luego llama

Ejemplos
Válido

Formulario
POST

Un POST al estilo JSON-RPC a la URL del relay: un método, sus parámetros, una respuesta.

Cabeceras

Indica al relay que esta petición HTTP es una llamada de gestión.

La cadena "Nostr " seguida del evento kind 27235 firmado y codificado en base64.

El evento de autorización dentro de la cabecera

{
  "kind": 27235,
  "created_at": 1735689600,
  "tags": [
    [
      "u",
      "https://relay.delta.example/"
    ],
    [
      "method",
      "POST"
    ],
    [
      "payload",
      "c8c5e8bc5a0a152d0537c925d29fa95a9456715bd77d6dd4c2e1f96175920ab5"
    ]
  ],
  "content": "",
  "pubkey": "1c028b39e7f3228444b3261e4b718efa92a91470086b44c9a72ef5357e970148",
  "id": "5b504ac6be7ecfa88f0c1fa0e51999ea45bcb5240b094cc1b6e2f4edd59c4857",
  "sig": "b8f8d10c380c8da6c22cf7dd20c39b1e4f72589d95698582920fe7ee7f887e603b3684618357f3b3a88cc18d2a4699010ab4a7294e82e7f60300d1247f626f42"
}

Cuerpo application/nostr+json+rpc

body

La llamada: qué método ejecutar y con qué parámetros.

Nombre del método a ejecutar.

params

Los argumentos del método, en orden. Un arreglo vacío para métodos sin parámetros.

Respuestas

  • 200 La llamada se procesó.
  • 401 Falta la cabecera Authorization o no es válida.

Cómo funciona este NIP

Paso 1 de 5

La misma dirección, HTTP normal

La API de gestión vive en la propia URL del relay, accesible por https en lugar de wss. El relay la reconoce por el Content-Type application/nostr+json+rpc.

En el curso

Ningún capítulo del curso cubre este NIP todavía. El editor de arriba es la forma más rápida de empezar.

Se basa en

  • NIP-98 HTTP Auth

    Cada llamada se autoriza con un evento NIP-98 en la cabecera Authorization.

Ver también

Especificación

El texto de las especificaciones se cita en inglés del repositorio nostr-protocol/nips. Nuestras explicaciones y la interfaz están traducidas. Código fuente en GitHub en el commit 0046368

Leer la especificación915 palabras, citadas del repositorio en el commit 0046368.

Relays may provide an API for performing management tasks. This is made available as a JSON-RPC-like request-response protocol over HTTP, on the same URI as the relay's websocket.

When a relay receives an HTTP(s) request with a Content-Type header of application/nostr+json+rpc to a URI supporting WebSocket upgrades, it should parse the request as a JSON document with the following fields:

{
  "method": "<method-name>",
  "params": ["<array>", "<of>", "<parameters>"]
}

Then it should return a response in the format

{
  "result": {"<arbitrary>": "<value>"},
  "error": "<optional error message, if the call has errored>"
}

This is the list of methods that may be supported:

supportedmethods

Lists the methods supported by the relay. May be customized to match permissions assigned to the authenticated user.

  • params: []
  • result: ["<method-name>", "<method-name>", ...] (an array with the names of all the other supported methods)

banpubkey

Bans a pubkey from the relay. Should automatically remove the pubkey from the allow list.

  • params: ["<32-byte-hex-public-key>", "<optional-reason>"]
  • result: true (a boolean always set to true)

unbanpubkey

Removes a pubkey from the relay's ban list. Should not automatically add the pubkey to the allow list.

  • params: ["<32-byte-hex-public-key>", "<optional-reason>"]
  • result: true (a boolean always set to true)

listbannedpubkeys

Lists pubkeys banned from the relay.

  • params: []
  • result: [{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...], an array of objects

allowpubkey

Adds a pubkey to the relay's allow list. Should automatically remove the pubkey from the ban list.

  • params: ["<32-byte-hex-public-key>", "<optional-reason>"]
  • result: true (a boolean always set to true)

unallowpubkey

Removes a pubkey from the relay's allow list. Should not automatically add the pubkey to the ban list.

  • params: ["<32-byte-hex-public-key>", "<optional-reason>"]
  • result: true (a boolean always set to true)

listallowedpubkeys

Lists pubkeys on the relay's allow list.

  • params: []
  • result: [{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...], an array of objects

createrole

Creates a new role.

  • params: [id, label, description, color, order]
  • result: true (boolean true)

editrole

Updates an existing role.

  • params: [id, label, description, color, order]
  • result: true (boolean true)

deleterole

Deletes a role.

  • params: [id]
  • result: true (boolean true)

assignrole

Assigns a role to a pubkey.

  • params: ["<32-byte-hex-public-key>", "<role-id>"]
  • result: true (a boolean always set to true)

unassignrole

Removes a role from a pubkey.

  • params: ["<32-byte-hex-public-key>", "<role-id>"]
  • result: true (a boolean always set to true)

listclaims

Lists NIP 43 invite codes currently accepted by the relay.

  • params: []
  • result: [claim, ...], an array of NIP 43 invite codes

createclaim

Creates a new NIP 43 invite code.

  • params: [claim]
  • result: true (boolean true)

deleteclaim

Revokes a NIP 43 invite code.

  • params: [claim]
  • result: true (boolean true)

listeventsneedingmoderation

Lists events awaiting moderation.

  • params: []
  • result: [{"id": "<32-byte-hex>", "reason": "<optional-reason>"}], an array of objects

allowevent

Adds an event to the relay's allow list. Should automatically remove the event from the ban list.

  • params: ["<32-byte-hex-event-id>", "<optional-reason>"]
  • result: true (a boolean always set to true)

unallowevent

Removes an event from the relay's allow list. Should not automatically add the event to the ban list.

  • params: ["<32-byte-hex-event-id>", "<optional-reason>"]
  • result: true (a boolean always set to true)

banevent

Bans an event from the relay. Should automatically remove the event from the allow list.

  • params: ["<32-byte-hex-event-id>", "<optional-reason>"]
  • result: true (a boolean always set to true)

unbanevent

Removes an event from the relay's ban list. Should not automatically add the event to the allow list.

  • params: ["<32-byte-hex-event-id>", "<optional-reason>"]
  • result: true (a boolean always set to true)

listbannedevents

Lists events banned from the relay.

  • params: []
  • result: [{"id": "<32-byte hex>", "reason": "<optional-reason>"}, ...], an array of objects

listallowedevents

Lists events on the relay's allow list.

  • params: []
  • result: [{"id": "<32-byte-hex>", "reason": "<optional-reason>"}, ...], an array of objects

changerelayname

Changes the relay's name.

  • params: ["<new-name>"]
  • result: true (a boolean always set to true)

changerelaydescription

Changes the relay's description.

  • params: ["<new-description>"]
  • result: true (a boolean always set to true)

changerelayicon

Changes the relay's icon.

  • params: ["<new-icon-url>"]
  • result: true (a boolean always set to true)

allowkind

Adds an event kind to the relay's allow list.

  • params: [<kind-number>]
  • result: true (a boolean always set to true)

disallowkind

Disallows an event kind.

  • params: [<kind-number>]
  • result: true (a boolean always set to true)

listallowedkinds

Lists event kinds on the relay's allow list.

  • params: []
  • result: [<kind-number>, ...], an array of numbers

listdisallowedkinds

Lists event kinds the relay disallows.

  • params: []
  • result: [<kind-number>, ...], an array of numbers

blockip

Adds an IP address to the relay's block list.

  • params: ["<ip-address>", "<optional-reason>"]
  • result: true (a boolean always set to true)

unblockip

Removes an IP address from the relay's block list.

  • params: ["<ip-address>"]
  • result: true (a boolean always set to true)

listblockedips

Lists IP addresses blocked by the relay.

  • params: []
  • result: [{"ip": "<ip-address>", "reason": "<optional-reason>"}, ...], an array of objects

Authorization

The request must contain an Authorization header with a valid NIP-98 event, except the payload tag is required. The u tag is the relay URL.

If Authorization is not provided or is invalid, the endpoint should return a 401 response.