Skip to content

Unsubscribe from a federation directory

DELETE
/admin/federation/directories/{id}

Deletes the subscription and the entries cached from that directory. Instances you’ve already paired with stay paired.

If your instance is listed in that directory, unsubscribing doesn’t ask the directory to remove it: it doesn’t contact the directory at all. Your instance’s own record of that listing is deleted with the subscription.

Deleting an id that doesn’t exist also returns 204. Needs the system.admin capability.

id
required
string format: uuid

Unsubscribed.

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed