Interface DomainAllowsResource

interface DomainAllowsResource {
    create: Method<
        DomainAllow,
        CreateDomainAllowParams,
        HttpMetaParams<"json">,
    >;
    list: Method<
        Paginator<DomainAllow[], DefaultPaginationParams>,
        DefaultPaginationParams,
    >;
    $select(id: string): DomainAllows$SelectResource;
}

Index

Properties

Methods

Properties

create

create: Method<DomainAllow, CreateDomainAllowParams, HttpMetaParams<"json">>

Add a domain to the list of domains allowed to federate, to be used when the instance is in allow-list federation mode.

Param: params

parameters

Returns

DomainAllow

See

https://docs.joinmastodon.org/methods/admin/domain_allows/#get-one

list

list: Method<
Paginator<DomainAllow[], DefaultPaginationParams>,
DefaultPaginationParams,
>

Show information about all allowed domains

Param: params

Parameters

Returns

Array of DomainAllow

See

https://docs.joinmastodon.org/methods/admin/domain_allows/#get

Methods

$select

$select(id: string): DomainAllows$SelectResource
Parameters
- id: string
Returns DomainAllows$SelectResource
- Defined in src/mastodon/rest/v1/admin/domain-allows.ts:28