Class: AdminEndpoint

Defined in: endpoints/admin.ts:29

Constructors

Constructor

new AdminEndpoint(client): AdminEndpoint;

Defined in: endpoints/admin.ts:30

Parameters

Parameter	Type
client	RESTClient

Returns

AdminEndpoint

Methods

acceptInstanceKey()

acceptInstanceKey(instanceId, heldMessages): Promise<IAdminFederatedInstanceResponse>;

Defined in: endpoints/admin.ts:51

Trust the new key an instance shows, applying or throwing away what it signed with it meanwhile.

Parameters

Parameter	Type
instanceId	number
heldMessages	IFederationHeldDecision

Returns

Promise<IAdminFederatedInstanceResponse>

---

approveInstance()

approveInstance(instanceId, heldMessages): Promise<IAdminFederatedInstanceResponse>;

Defined in: endpoints/admin.ts:38

Let in an instance waiting for approval, applying or throwing away what it sent meanwhile.

Parameters

Parameter	Type
instanceId	number
heldMessages	IFederationHeldDecision

Returns

Promise<IAdminFederatedInstanceResponse>

---

checkInstance()

checkInstance(instanceId): Promise<IAdminFederatedInstanceResponse>;

Defined in: endpoints/admin.ts:64

Check now whether an unavailable instance is back, sending what waits for it if it is.

Parameters

Parameter	Type
instanceId	number

Returns

Promise<IAdminFederatedInstanceResponse>

---

checkPushRelay()

checkPushRelay(): Promise<IInstancePushRelayResponse>;

Defined in: endpoints/admin.ts:97

Checks approval and securely stores credentials on the instance when approved.

Returns

Promise<IInstancePushRelayResponse>

---

createIpBan()

createIpBan(payload): Promise<ICreateIpBansResponse>;

Defined in: endpoints/admin.ts:135

Ban one address or CIDR range, or every address a user has connected from. Instance admins only; the address you are connected from is refused.

Parameters

Parameter	Type
payload	| { address: string; reason?: string; } | { reason?: string; userId: number; }

Returns

Promise<ICreateIpBansResponse>

---

deleteIpBan()

deleteIpBan(banId): Promise<{
  success: boolean;
}>;

Defined in: endpoints/admin.ts:141

Parameters

Parameter	Type
banId	number

Returns

Promise<{ success: boolean; }>

---

deleteUser()

deleteUser(userId): Promise<IAdminDeleteUsersResponse>;

Defined in: endpoints/admin.ts:171

Delete an account after transferring any servers it owns. Instance admins only.

Parameters

Parameter	Type
userId	number

Returns

Promise<IAdminDeleteUsersResponse>

---

deleteUsers()

deleteUsers(userIds): Promise<IAdminDeleteUsersResponse>;

Defined in: endpoints/admin.ts:176

Delete 1–100 accounts atomically. The signed-in administrator cannot be included.

Parameters

Parameter	Type
userIds	number[]

Returns

Promise<IAdminDeleteUsersResponse>

---

getAdminServers()

getAdminServers(): Promise<IAdminServersResponse>;

Defined in: endpoints/admin.ts:114

Returns

Promise<IAdminServersResponse>

---

getAdminStats()

getAdminStats(): Promise<IAdminStatsResponse>;

Defined in: endpoints/admin.ts:118

Returns

Promise<IAdminStatsResponse>

---

getAdminUserDetails()

getAdminUserDetails(userId): Promise<IAdminUserDetailsResponse>;

Defined in: endpoints/admin.ts:110

The servers an account belongs to and the bans on it. Instance admins only.

Parameters

Parameter	Type
userId	number

Returns

Promise<IAdminUserDetailsResponse>

---

getAdminUsers()

getAdminUsers(): Promise<IAdminUsersResponse>;

Defined in: endpoints/admin.ts:105

Returns

Promise<IAdminUsersResponse>

---

getAnalytics()

getAnalytics(range?): Promise<IAnalyticsDashboardResponse>;

Defined in: endpoints/admin.ts:69

Historical telemetry and current inventory. Instance admins only.

Parameters

Parameter	Type
range?	"24h" | "7d" | "30d" | "90d"

Returns

Promise<IAnalyticsDashboardResponse>

---

getFederation()

getFederation(): Promise<IAdminFederationResponse>;

Defined in: endpoints/admin.ts:33

The other instances this one knows, and any waiting for a decision. Instance admins only.

Returns

Promise<IAdminFederationResponse>

---

getInstanceSettings()

getInstanceSettings(): Promise<IInstanceSettingsResponse>;

Defined in: endpoints/admin.ts:84

Returns

Promise<IInstanceSettingsResponse>

---

getPendingUsers()

getPendingUsers(): Promise<IAdminPendingUsersResponse>;

Defined in: endpoints/admin.ts:122

Returns

Promise<IAdminPendingUsersResponse>

---

getPushRelay()

getPushRelay(): Promise<IInstancePushRelayResponse>;

Defined in: endpoints/admin.ts:88

Returns

Promise<IInstancePushRelayResponse>

---

getUserIpAddresses()

getUserIpAddresses(userId): Promise<IUserIpAddressesResponse>;

Defined in: endpoints/admin.ts:146

Addresses a user has connected from, most recent first. Instance admins only.

Parameters

Parameter	Type
userId	number

Returns

Promise<IUserIpAddressesResponse>

---

listIpBans()

listIpBans(): Promise<IIpBansResponse>;

Defined in: endpoints/admin.ts:127

Instance admins only.

Returns

Promise<IIpBansResponse>

---

registerPushRelay()

registerPushRelay(): Promise<IInstancePushRelayResponse>;

Defined in: endpoints/admin.ts:92

Returns

Promise<IInstancePushRelayResponse>

---

rejectInstance()

rejectInstance(instanceId): Promise<IAdminFederatedInstanceResponse>;

Defined in: endpoints/admin.ts:46

Refuse an instance: nothing more is taken from it or sent to it.

Parameters

Parameter	Type
instanceId	number

Returns

Promise<IAdminFederatedInstanceResponse>

---

rejectInstanceKey()

rejectInstanceKey(instanceId): Promise<IAdminFederatedInstanceResponse>;

Defined in: endpoints/admin.ts:59

Refuse the new key an instance shows; what was signed with it is thrown away.

Parameters

Parameter	Type
instanceId	number

Returns

Promise<IAdminFederatedInstanceResponse>

---

resetUserProfile()

resetUserProfile(userId): Promise<{
  success: boolean;
}>;

Defined in: endpoints/admin.ts:154

Clear someone's profile customisation: display name, pronouns, bio, colours, shape, custom CSS and pictures. Their username and badges stay.

Parameters

Parameter	Type
userId	number

Returns

Promise<{ success: boolean; }>

---

updateAnalyticsPreferences()

updateAnalyticsPreferences(preferences): Promise<IAnalyticsPreferencesResponse>;

Defined in: endpoints/admin.ts:78

Saves only the signed-in administrator's dashboard layout.

Parameters

Parameter	Type
preferences	Partial<IAnalyticsPreferences>

Returns

Promise<IAnalyticsPreferencesResponse>

---

updateAnalyticsSettings()

updateAnalyticsSettings(settings): Promise<IAnalyticsSettingsResponse>;

Defined in: endpoints/admin.ts:73

Parameters

Parameter	Type
settings	Partial<IAnalyticsSettings>

Returns

Promise<IAnalyticsSettingsResponse>

---

updateInstanceSettings()

updateInstanceSettings(settings): Promise<IInstanceSettingsResponse>;

Defined in: endpoints/admin.ts:101

Parameters

Parameter	Type
settings	IUpdateInstanceSettings

Returns

Promise<IInstanceSettingsResponse>

---

updateUserRole()

updateUserRole(userId, newRole): Promise<IAdminUpdateUserRoleResponse>;

Defined in: endpoints/admin.ts:158

Parameters

Parameter	Type
userId	number
newRole	string

Returns

Promise<IAdminUpdateUserRoleResponse>

---

updateUserRoles()

updateUserRoles(userIds, newRole): Promise<IAdminUpdateUserRolesResponse>;

Defined in: endpoints/admin.ts:166

Apply one role atomically to 1–100 users.

Parameters

Parameter	Type
userIds	number[]
newRole	IUserInstanceRole

Returns

Promise<IAdminUpdateUserRolesResponse>