Interface IpBlocksResource

interface IpBlocksResource {
    $select(id: string): IpBlocks$SelectResource;
    create(
        params: CreateIpBlockParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<IpBlock>;
    list(
        params?: ListIpBlocksParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<IpBlock[], ListIpBlocksParams>;
}

Index

Methods

$select create list

Methods

$select

$select(id: string): IpBlocks$SelectResource
Parameters
- id: string
Returns IpBlocks$SelectResource
- Defined in src/mastodon/rest/v1/admin/ip-blocks.ts:61

create

create(
params: CreateIpBlockParams,
meta?: HttpMetaParams<"json">,
): Promise<IpBlock>
Add an IP address range to the list of IP blocks.
Parameters
- params: CreateIpBlockParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<IpBlock>
IpBlock

See
https://docs.joinmastodon.org/methods/admin/ip_blocks/#post
- Defined in src/mastodon/rest/v1/admin/ip-blocks.ts:80

list

list(
params?: ListIpBlocksParams,
meta?: HttpMetaParams<"none">,
): Paginator<IpBlock[], ListIpBlocksParams>
Show information about all blocked IP ranges.
Parameters
- Optionalparams: ListIpBlocksParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<IpBlock[], ListIpBlocksParams>
Array of IpBlock

See
https://docs.joinmastodon.org/methods/admin/ip_blocks/#get
- Defined in src/mastodon/rest/v1/admin/ip-blocks.ts:69