openapi: 3.1.0 info: version: 2025.4.1-io.12b-fb6fbea074 title: Misskey account Admin API servers: - url: https://misskey.io/api tags: - name: Admin paths: /admin/emoji/import-zip: post: operationId: post___admin___emoji___import-zip summary: admin/emoji/import-zip description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/import-zip.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: fileId: type: string format: misskey:id required: - fileId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - Admin /admin/abuse-report-resolver/create: post: operationId: post___admin___abuse-report-resolver___create summary: admin/abuse-report-resolver/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:abuse-report-resolvers*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 targetUserPattern: type: - string - 'null' reporterPattern: type: - string - 'null' reportContentPattern: type: - string - 'null' expiresAt: type: string enum: - 1hour - 12hours - 1day - 1week - 1month - 3months - 6months - 1year - indefinitely forward: type: boolean required: - name - targetUserPattern - reporterPattern - reportContentPattern - expiresAt - forward responses: '200': description: OK (with results) content: application/json: schema: type: object properties: name: type: string targetUserPattern: type: - string - 'null' reporterPattern: type: - string - 'null' reportContentPattern: type: - string - 'null' expiresAt: type: string forward: type: boolean required: - name - targetUserPattern - reporterPattern - reportContentPattern - expiresAt - forward '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER: value: error: message: Invalid regular expression for target user. code: INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER id: c008484a-0a14-4e74-86f4-b176dc49fcaa INVALID_REGULAR_EXPRESSION_FOR_REPORTER: value: error: message: Invalid regular expression for reporter. code: INVALID_REGULAR_EXPRESSION_FOR_REPORTER id: 399b4062-257f-44c8-87cc-4ffae2527fbc INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT: value: error: message: Invalid regular expression for report content. code: INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT id: 88c124d8-f517-4c63-a464-0abc274168b INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report-resolver/delete: post: operationId: post___admin___abuse-report-resolver___delete summary: admin/abuse-report-resolver/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:abuse-report-resolvers*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: resolverId: type: string format: misskey:id required: - resolverId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: RESOLVER_NOT_FOUND: value: error: message: Resolver not found. code: RESOLVER_NOT_FOUND id: 121fbea9-3e49-4456-998a-d4095c7ac5c5 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report-resolver/list: post: operationId: post___admin___abuse-report-resolver___list summary: admin/abuse-report-resolver/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:abuse-report-resolvers*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: number minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: name: type: string targetUserPattern: type: - string - 'null' reporterPattern: type: - string - 'null' reportContentPattern: type: - string - 'null' expiresAt: type: string forward: type: boolean required: - name - targetUserPattern - reporterPattern - reportContentPattern - expiresAt - forward '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report-resolver/update: post: operationId: post___admin___abuse-report-resolver___update summary: admin/abuse-report-resolver/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:abuse-report-resolvers*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: resolverId: type: string format: misskey:id name: type: string targetUserPattern: type: - string - 'null' reporterPattern: type: - string - 'null' reportContentPattern: type: - string - 'null' expiresAt: type: string enum: - 1hour - 12hours - 1day - 1week - 1month - 3months - 6months - 1year - indefinitely forward: type: boolean required: - resolverId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: RESOLVER_NOT_FOUND: value: error: message: Resolver not found. id: fd32710e-75e1-4d20-bbd2-f89029acb16e code: RESOLVER_NOT_FOUND INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER: value: error: message: Invalid regular expression for target user. code: INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER id: c008484a-0a14-4e74-86f4-b176dc49fcaa INVALID_REGULAR_EXPRESSION_FOR_REPORTER: value: error: message: Invalid regular expression for reporter. code: INVALID_REGULAR_EXPRESSION_FOR_REPORTER id: 399b4062-257f-44c8-87cc-4ffae2527fbc INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT: value: error: message: Invalid regular expression for report content. code: INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT id: 88c124d8-f517-4c63-a464-0abc274168b INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report/notification-recipient/create: post: operationId: post___admin___abuse-report___notification-recipient___create summary: admin/abuse-report/notification-recipient/create description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: isActive: type: boolean name: type: string minLength: 1 maxLength: 255 method: type: string enum: - email - webhook userId: type: string format: misskey:id systemWebhookId: type: string format: misskey:id required: - isActive - name - method responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/AbuseReportNotificationRecipient' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CORRELATION_CHECK_EMAIL: value: error: message: If "method" is email, "userId" must be set. code: CORRELATION_CHECK_EMAIL id: 348bb8ae-575a-6fe9-4327-5811999def8f httpStatusCode: 400 CORRELATION_CHECK_WEBHOOK: value: error: message: If "method" is webhook, "systemWebhookId" must be set. code: CORRELATION_CHECK_WEBHOOK id: b0c15051-de2d-29ef-260c-9585cddd701a httpStatusCode: 400 EMAIL_ADDRESS_NOT_SET: value: error: message: Email address is not set. code: EMAIL_ADDRESS_NOT_SET id: 7cc1d85e-2f58-fc31-b644-3de8d0d3421f httpStatusCode: 400 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report/notification-recipient/delete: post: operationId: post___admin___abuse-report___notification-recipient___delete summary: admin/abuse-report/notification-recipient/delete description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report/notification-recipient/list: post: operationId: post___admin___abuse-report___notification-recipient___list summary: admin/abuse-report/notification-recipient/list description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *read:admin:abuse-report:notification-recipient*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: method: type: array items: type: string enum: - email - webhook responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/AbuseReportNotificationRecipient' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report/notification-recipient/show: post: operationId: post___admin___abuse-report___notification-recipient___show summary: admin/abuse-report/notification-recipient/show description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *read:admin:abuse-report:notification-recipient*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/show.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/AbuseReportNotificationRecipient' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_RECIPIENT: value: error: message: No such recipient. code: NO_SUCH_RECIPIENT id: 013de6a8-f757-04cb-4d73-cc2a7e3368e4 kind: server httpStatusCode: 404 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-report/notification-recipient/update: post: operationId: post___admin___abuse-report___notification-recipient___update summary: admin/abuse-report/notification-recipient/update description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id isActive: type: boolean name: type: string minLength: 1 maxLength: 255 method: type: string enum: - email - webhook userId: type: string format: misskey:id systemWebhookId: type: string format: misskey:id required: - id - isActive - name - method responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/AbuseReportNotificationRecipient' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CORRELATION_CHECK_EMAIL: value: error: message: If "method" is email, "userId" must be set. code: CORRELATION_CHECK_EMAIL id: 348bb8ae-575a-6fe9-4327-5811999def8f httpStatusCode: 400 CORRELATION_CHECK_WEBHOOK: value: error: message: If "method" is webhook, "systemWebhookId" must be set. code: CORRELATION_CHECK_WEBHOOK id: b0c15051-de2d-29ef-260c-9585cddd701a httpStatusCode: 400 EMAIL_ADDRESS_NOT_SET: value: error: message: Email address is not set. code: EMAIL_ADDRESS_NOT_SET id: 7cc1d85e-2f58-fc31-b644-3de8d0d3421f httpStatusCode: 400 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/abuse-user-reports: post: operationId: post___admin___abuse-user-reports summary: admin/abuse-user-reports description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:abuse-user-reports*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-user-reports.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id state: type: - string - 'null' default: null reporterOrigin: type: string enum: - combined - local - remote default: combined targetUserOrigin: type: string enum: - combined - local - remote default: combined forwarded: type: boolean default: false category: type: - string - 'null' default: null responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time comment: type: string resolved: type: boolean example: false forwarded: type: boolean example: false resolvedAs: type: - string - 'null' enum: - accept - reject - null reporterId: type: string format: id targetUserId: type: string format: id assigneeId: type: - string - 'null' format: id reporter: type: object $ref: '#/components/schemas/UserDetailed' targetUser: type: object $ref: '#/components/schemas/UserDetailed' assignee: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserDetailed' - type: 'null' category: type: string moderationNote: type: - string - 'null' required: - id - createdAt - comment - resolved - forwarded - resolvedAs - reporterId - targetUserId - assigneeId - reporter - targetUser - category - moderationNote '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/accounts/create: post: operationId: post___admin___accounts___create summary: admin/accounts/create description: 'No description provided. **Credential required**: *No*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/accounts/create.ts tags: - Admin requestBody: required: true content: application/json: schema: type: object properties: username: type: string pattern: ^\w{1,20}$ password: type: string minLength: 1 setupPassword: type: - string - 'null' required: - username - password responses: '200': description: OK (with results) content: application/json: schema: type: object properties: token: type: string required: - token $ref: '#/components/schemas/MeDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: ACCESS_DENIED: value: error: message: Access denied. code: ACCESS_DENIED id: 1fb7cb09-d46a-4fff-b8df-057708cce513 INCORRECT_INITIAL_PASSWORD: value: error: message: Initial password is incorrect. code: INCORRECT_INITIAL_PASSWORD id: 97147c55-1ae1-4f6f-91d6-e1c3e0e76d62 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/accounts/delete: post: operationId: post___admin___accounts___delete summary: admin/accounts/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/accounts/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id soft: type: boolean default: true description: Since deletion by an administrator is a moderation action, the default is to soft delete. required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: USER_NOT_FOUND: value: error: message: User not found. code: USER_NOT_FOUND id: 6c45276a-525e-46b0-892f-17a5036258bf CANNOT_DELETE_MODERATOR: value: error: message: Cannot delete a moderator. code: CANNOT_DELETE_MODERATOR id: d195c621-f21a-4c2f-a634-484c2a616311 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/accounts/find-by-email: post: operationId: post___admin___accounts___find-by-email summary: admin/accounts/find-by-email description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/accounts/find-by-email.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: email: type: string required: - email responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/UserDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: USER_NOT_FOUND: value: error: message: No such user who has the email address. code: USER_NOT_FOUND id: cb865949-8af5-4062-a88c-ef55e8786d1d INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/accounts/pending/list: post: operationId: post___admin___accounts___pending___list summary: admin/accounts/pending/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/accounts/pending/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 sort: type: string enum: - +createdAt - -createdAt username: type: - string - 'null' default: null email: type: - string - 'null' default: null code: type: - string - 'null' default: null responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time code: type: string username: type: string example: ai email: type: - string - 'null' required: - id - createdAt - code - username '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/accounts/pending/revoke: post: operationId: post___admin___accounts___pending___revoke summary: admin/accounts/pending/revoke description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/accounts/pending/revoke.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id code: type: string anyOf: - required: - id - required: - code responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: PENDING_USER_NOT_FOUND: value: error: message: Pending User not found. code: PENDING_USER_NOT_FOUND id: a04d6118-65e6-4508-9144-9900a331bbf3 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/ad/create: post: operationId: post___admin___ad___create summary: admin/ad/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:ad*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/ad/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: url: type: string minLength: 1 memo: type: string place: type: string priority: type: string ratio: type: integer expiresAt: type: integer startsAt: type: integer imageUrl: type: string minLength: 1 dayOfWeek: type: integer isSensitive: type: boolean default: false required: - url - memo - place - priority - ratio - expiresAt - startsAt - imageUrl - dayOfWeek responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/Ad' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/ad/delete: post: operationId: post___admin___ad___delete summary: admin/ad/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:ad*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/ad/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_AD: value: error: message: No such ad. code: NO_SUCH_AD id: ccac9863-3a03-416e-b899-8a64041118b1 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/ad/list: post: operationId: post___admin___ad___list summary: admin/ad/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:ad*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/ad/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id publishing: type: - boolean - 'null' default: null responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Ad' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/ad/update: post: operationId: post___admin___ad___update summary: admin/ad/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:ad*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/ad/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id memo: type: string url: type: string minLength: 1 imageUrl: type: string minLength: 1 place: type: string priority: type: string ratio: type: integer expiresAt: type: integer startsAt: type: integer dayOfWeek: type: integer isSensitive: type: boolean required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_AD: value: error: message: No such ad. code: NO_SUCH_AD id: b7aa1727-1354-47bc-a182-3a9c3973d300 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/announcements/create: post: operationId: post___admin___announcements___create summary: admin/announcements/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:announcements*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/announcements/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: title: type: string minLength: 1 text: type: string minLength: 1 imageUrl: type: - string - 'null' minLength: 0 icon: type: string enum: - info - warning - error - success default: info display: type: string enum: - normal - banner - dialog default: normal forExistingUsers: type: boolean default: false needConfirmationToRead: type: boolean default: false needEnrollmentTutorialToRead: type: boolean default: false closeDuration: type: number default: 0 displayOrder: type: number default: 0 silence: type: boolean default: false userId: type: - string - 'null' format: misskey:id default: null required: - title - text - imageUrl responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time title: type: string text: type: string imageUrl: type: - string - 'null' icon: type: string display: type: string forYou: type: boolean needConfirmationToRead: type: boolean needEnrollmentTutorialToRead: type: boolean closeDuration: type: number displayOrder: type: number silence: type: boolean isRead: type: boolean required: - id - createdAt - updatedAt - title - text - imageUrl - icon - display - forYou - needConfirmationToRead - needEnrollmentTutorialToRead - closeDuration - displayOrder - silence '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/announcements/delete: post: operationId: post___admin___announcements___delete summary: admin/announcements/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:announcements*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/announcements/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANNOUNCEMENT: value: error: message: No such announcement. code: NO_SUCH_ANNOUNCEMENT id: ecad8040-a276-4e85-bda9-015a708d291e INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/announcements/list: post: operationId: post___admin___announcements___list summary: admin/announcements/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:announcements*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/announcements/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 userId: type: - string - 'null' format: misskey:id status: type: - string - 'null' enum: - active - archived responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time text: type: string isActive: type: boolean title: type: string imageUrl: type: - string - 'null' icon: type: string display: type: string forExistingUsers: type: boolean needConfirmationToRead: type: boolean needEnrollmentTutorialToRead: type: boolean closeDuration: type: number displayOrder: type: number silence: type: boolean userId: type: - string - 'null' user: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' reads: type: number lastReadAt: type: - string - 'null' format: date-time required: - id - createdAt - updatedAt - text - isActive - title - imageUrl - icon - display - forExistingUsers - needConfirmationToRead - needEnrollmentTutorialToRead - closeDuration - displayOrder - silence - userId - user - reads - lastReadAt '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/announcements/update: post: operationId: post___admin___announcements___update summary: admin/announcements/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:announcements*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/announcements/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id title: type: string minLength: 1 text: type: string minLength: 1 imageUrl: type: - string - 'null' minLength: 0 icon: type: string enum: - info - warning - error - success display: type: string enum: - normal - banner - dialog forExistingUsers: type: boolean needConfirmationToRead: type: boolean needEnrollmentTutorialToRead: type: boolean closeDuration: type: number default: 0 displayOrder: type: number default: 0 silence: type: boolean isActive: type: boolean required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANNOUNCEMENT: value: error: message: No such announcement. code: NO_SUCH_ANNOUNCEMENT id: d3aae5a7-6372-4cb4-b61c-f511ffc2d7cc INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/avatar-decorations/create: post: operationId: post___admin___avatar-decorations___create summary: admin/avatar-decorations/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/avatar-decorations/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 description: type: string url: type: string minLength: 1 roleIdsThatCanBeUsedThisDecoration: type: array items: type: string required: - name - description - url responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string format: id createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time name: type: string description: type: string url: type: string roleIdsThatCanBeUsedThisDecoration: type: array items: type: string format: id required: - id - createdAt - updatedAt - name - description - url - roleIdsThatCanBeUsedThisDecoration '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/avatar-decorations/delete: post: operationId: post___admin___avatar-decorations___delete summary: admin/avatar-decorations/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/avatar-decorations/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/avatar-decorations/list: post: operationId: post___admin___avatar-decorations___list summary: admin/avatar-decorations/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:avatar-decorations*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/avatar-decorations/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id userId: type: - string - 'null' format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time name: type: string description: type: string url: type: string roleIdsThatCanBeUsedThisDecoration: type: array items: type: string format: id required: - id - createdAt - updatedAt - name - description - url - roleIdsThatCanBeUsedThisDecoration '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/avatar-decorations/update: post: operationId: post___admin___avatar-decorations___update summary: admin/avatar-decorations/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:avatar-decorations*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/avatar-decorations/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id name: type: string minLength: 1 description: type: string url: type: string minLength: 1 roleIdsThatCanBeUsedThisDecoration: type: array items: type: string required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/captcha/current: post: operationId: post___admin___captcha___current summary: admin/captcha/current description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:meta*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/captcha/current.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: object properties: provider: type: string enum: - none - hcaptcha - mcaptcha - recaptcha - turnstile - testcaptcha hcaptcha: type: object properties: siteKey: type: - string - 'null' secretKey: type: - string - 'null' required: - siteKey - secretKey mcaptcha: type: object properties: siteKey: type: - string - 'null' secretKey: type: - string - 'null' instanceUrl: type: - string - 'null' required: - siteKey - secretKey - instanceUrl recaptcha: type: object properties: siteKey: type: - string - 'null' secretKey: type: - string - 'null' required: - siteKey - secretKey turnstile: type: object properties: siteKey: type: - string - 'null' secretKey: type: - string - 'null' required: - siteKey - secretKey required: - provider - hcaptcha - mcaptcha - recaptcha - turnstile '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/captcha/save: post: operationId: post___admin___captcha___save summary: admin/captcha/save description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:meta*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/captcha/save.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: provider: type: string enum: - none - hcaptcha - mcaptcha - recaptcha - turnstile - testcaptcha captchaResult: type: - string - 'null' sitekey: type: - string - 'null' secret: type: - string - 'null' instanceUrl: type: - string - 'null' required: - provider responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PROVIDER: value: error: message: Invalid provider. code: INVALID_PROVIDER id: 14bf7ae1-80cc-4363-acb2-4fd61d086af0 httpStatusCode: 400 INVALID_PARAMETERS: value: error: message: Invalid parameters. code: INVALID_PARAMETERS id: 26654194-410e-44e2-b42e-460ff6f92476 httpStatusCode: 400 NO_RESPONSE_PROVIDED: value: error: message: No response provided. code: NO_RESPONSE_PROVIDED id: 40acbba8-0937-41fb-bb3f-474514d40afe httpStatusCode: 400 REQUEST_FAILED: value: error: message: Request failed. code: REQUEST_FAILED id: 0f4fe2f1-2c15-4d6e-b714-efbfcde231cd httpStatusCode: 500 VERIFICATION_FAILED: value: error: message: Verification failed. code: VERIFICATION_FAILED id: c41c067f-24f3-4150-84b2-b5a3ae8c2214 httpStatusCode: 400 UNKNOWN: value: error: message: unknown code: UNKNOWN id: f868d509-e257-42a9-99c1-42614b031a97 httpStatusCode: 500 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/drive/clean-remote-files: post: operationId: post___admin___drive___clean-remote-files summary: admin/drive/clean-remote-files description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:drive*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/drive/clean-remote-files.ts tags: - Admin security: - bearerAuth: [] responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/drive/cleanup: post: operationId: post___admin___drive___cleanup summary: admin/drive/cleanup description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:drive*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/drive/cleanup.ts tags: - Admin security: - bearerAuth: [] responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/drive/delete-all-files-of-a-user: post: operationId: post___admin___drive___delete-all-files-of-a-user summary: admin/drive/delete-all-files-of-a-user description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:drive*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/drive/delete-all-files-of-a-user.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/drive/files: post: operationId: post___admin___drive___files summary: admin/drive/files description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:drive*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/drive/files.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id userId: type: - string - 'null' format: misskey:id type: type: - string - 'null' pattern: ^[a-zA-Z0-9\/\-*]+$ origin: type: string enum: - combined - local - remote default: local hostname: type: - string - 'null' default: null description: The local host is represented with `null`. responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/DriveFile' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/drive/show-file: post: operationId: post___admin___drive___show-file summary: admin/drive/show-file description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:drive*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/drive/show-file.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: fileId: type: string format: misskey:id url: type: string anyOf: - required: - fileId - required: - url responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time userId: type: - string - 'null' format: id example: xxxxxxxxxx userHost: type: - string - 'null' description: The local host is represented with `null`. md5: type: string format: md5 example: 15eca7fba0480996e2245f5185bf39f2 name: type: string example: 192.jpg type: type: string example: image/jpeg size: type: number example: 51469 comment: type: - string - 'null' blurhash: type: - string - 'null' properties: type: object properties: width: type: number height: type: number orientation: type: number avgColor: type: string storedInternal: type: - boolean - 'null' example: true url: type: - string - 'null' format: url thumbnailUrl: type: - string - 'null' format: url webpublicUrl: type: - string - 'null' format: url accessKey: type: - string - 'null' thumbnailAccessKey: type: - string - 'null' webpublicAccessKey: type: - string - 'null' uri: type: - string - 'null' src: type: - string - 'null' folderId: type: - string - 'null' format: id example: xxxxxxxxxx isSensitive: type: boolean isLink: type: boolean required: - id - createdAt - userId - userHost - md5 - name - type - size - comment - blurhash - properties - storedInternal - url - thumbnailUrl - webpublicUrl - accessKey - thumbnailAccessKey - webpublicAccessKey - uri - src - folderId - isSensitive - isLink '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: caf3ca38-c6e5-472e-a30c-b05377dcc240 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/add: post: operationId: post___admin___emoji___add summary: admin/emoji/add description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/add.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string pattern: ^[a-zA-Z0-9_]+$ fileId: type: string format: misskey:id category: type: - string - 'null' description: Use `null` to reset the category. aliases: type: array items: type: string license: type: - string - 'null' isSensitive: type: boolean localOnly: type: boolean requestedBy: type: - string - 'null' memo: type: - string - 'null' roleIdsThatCanBeUsedThisEmojiAsReaction: type: array items: type: string format: misskey:id roleIdsThatCanNotBeUsedThisEmojiAsReaction: type: array items: type: string format: misskey:id required: - name - fileId responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/EmojiDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: fc46b5a4-6b92-4c33-ac66-b806659bb5cf UNSUPPORTED_FILE_TYPE: value: error: message: Unsupported file type. code: UNSUPPORTED_FILE_TYPE id: f7599d96-8750-af68-1633-9575d625c1a7 DUPLICATE_NAME: value: error: message: Duplicate name. code: DUPLICATE_NAME id: f7a3462c-4e6e-4069-8421-b9bd4f4c3975 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/add-aliases-bulk: post: operationId: post___admin___emoji___add-aliases-bulk summary: admin/emoji/add-aliases-bulk description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/add-aliases-bulk.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id aliases: type: array items: type: string required: - ids - aliases responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/copy: post: operationId: post___admin___emoji___copy summary: admin/emoji/copy description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/copy.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: emojiId: type: string format: misskey:id required: - emojiId responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string format: id required: - id '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_EMOJI: value: error: message: No such emoji. code: NO_SUCH_EMOJI id: e2785b66-dca3-4087-9cac-b93c541cc425 DUPLICATE_NAME: value: error: message: Duplicate name. code: DUPLICATE_NAME id: f7a3462c-4e6e-4069-8421-b9bd4f4c3975 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/delete: post: operationId: post___admin___emoji___delete summary: admin/emoji/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_EMOJI: value: error: message: No such emoji. code: NO_SUCH_EMOJI id: be83669b-773a-44b7-b1f8-e5e5170ac3c2 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/delete-bulk: post: operationId: post___admin___emoji___delete-bulk summary: admin/emoji/delete-bulk description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/delete-bulk.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id required: - ids responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/list: post: operationId: post___admin___emoji___list summary: admin/emoji/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: query: type: - string - 'null' default: null limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id aliases: type: array items: type: string name: type: string category: type: - string - 'null' host: type: - string - 'null' description: The local host is represented with `null`. The field exists for compatibility with other API endpoints that return files. url: type: string required: - id - aliases - name - category - host - url '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/list-remote: post: operationId: post___admin___emoji___list-remote summary: admin/emoji/list-remote description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/list-remote.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: query: type: - string - 'null' default: null host: type: - string - 'null' default: null description: Use `null` to represent the local host. limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id aliases: type: array items: type: string name: type: string category: type: - string - 'null' host: type: - string - 'null' description: The local host is represented with `null`. url: type: string required: - id - aliases - name - category - host - url '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/remove-aliases-bulk: post: operationId: post___admin___emoji___remove-aliases-bulk summary: admin/emoji/remove-aliases-bulk description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/remove-aliases-bulk.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id aliases: type: array items: type: string required: - ids - aliases responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/set-aliases-bulk: post: operationId: post___admin___emoji___set-aliases-bulk summary: admin/emoji/set-aliases-bulk description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/set-aliases-bulk.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id aliases: type: array items: type: string required: - ids - aliases responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/set-category-bulk: post: operationId: post___admin___emoji___set-category-bulk summary: admin/emoji/set-category-bulk description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/set-category-bulk.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id category: type: - string - 'null' description: Use `null` to reset the category. required: - ids responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/set-license-bulk: post: operationId: post___admin___emoji___set-license-bulk summary: admin/emoji/set-license-bulk description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/set-license-bulk.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id license: type: - string - 'null' description: Use `null` to reset the license. required: - ids responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/emoji/update: post: operationId: post___admin___emoji___update summary: admin/emoji/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/emoji/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id name: type: string pattern: ^[a-zA-Z0-9_]+$ fileId: type: string format: misskey:id category: type: - string - 'null' description: Use `null` to reset the category. aliases: type: array items: type: string license: type: - string - 'null' isSensitive: type: boolean localOnly: type: boolean requestedBy: type: - string - 'null' memo: type: - string - 'null' roleIdsThatCanBeUsedThisEmojiAsReaction: type: array items: type: string format: misskey:id roleIdsThatCanNotBeUsedThisEmojiAsReaction: type: array items: type: string format: misskey:id anyOf: - required: - id - required: - name responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_EMOJI: value: error: message: No such emoji. code: NO_SUCH_EMOJI id: 684dec9d-a8c2-4364-9aa8-456c49cb1dc8 NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: 14fb9fd9-0731-4e2f-aeb9-f09e4740333d SAME_NAME_EMOJI_EXISTS: value: error: message: Emoji that have same name already exists. code: SAME_NAME_EMOJI_EXISTS id: 7180fe9d-1ee3-bff9-647d-fe9896d2ffb8 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/federation/delete-all-files: post: operationId: post___admin___federation___delete-all-files summary: admin/federation/delete-all-files description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:federation*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/federation/delete-all-files.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string required: - host responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/federation/refresh-remote-instance-metadata: post: operationId: post___admin___federation___refresh-remote-instance-metadata summary: admin/federation/refresh-remote-instance-metadata description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:federation*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/federation/refresh-remote-instance-metadata.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string required: - host responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/federation/remove-all-following: post: operationId: post___admin___federation___remove-all-following summary: admin/federation/remove-all-following description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:federation*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/federation/remove-all-following.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string required: - host responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/federation/update-instance: post: operationId: post___admin___federation___update-instance summary: admin/federation/update-instance description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:federation*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/federation/update-instance.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string isSuspended: type: boolean moderationNote: type: string required: - host responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/forward-abuse-user-report: post: operationId: post___admin___forward-abuse-user-report summary: admin/forward-abuse-user-report description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:resolve-abuse-user-report*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/forward-abuse-user-report.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: reportId: type: string format: misskey:id required: - reportId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ABUSE_REPORT: value: error: message: No such abuse report. code: NO_SUCH_ABUSE_REPORT id: 8763e21b-d9bc-40be-acf6-54c1a6986493 kind: server httpStatusCode: 404 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/get-index-stats: post: operationId: post___admin___get-index-stats summary: admin/get-index-stats description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:index-stats*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/get-index-stats.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: tablename: type: string indexname: type: string required: - tablename - indexname '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/get-table-stats: post: operationId: post___admin___get-table-stats summary: admin/get-table-stats description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:table-stats*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/get-table-stats.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: object additionalProperties: type: object properties: count: type: number size: type: number required: - count - size example: migrations: count: 66 size: 32768 '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/get-user-ips: post: operationId: post___admin___get-user-ips summary: admin/get-user-ips description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:user-ips*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/get-user-ips.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: ip: type: string createdAt: type: string format: date-time required: - ip - createdAt '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/indie-auth/create: post: operationId: post___admin___indie-auth___create summary: admin/indie-auth/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:indie-auth*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/indie-auth/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string minLength: 1 name: type: - string - 'null' redirectUris: type: array minItems: 1 items: type: string required: - id responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string createdAt: type: string format: date-time name: type: - string - 'null' redirectUris: type: array items: type: string required: - id - createdAt - name - redirectUris '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/indie-auth/delete: post: operationId: post___admin___indie-auth___delete summary: admin/indie-auth/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:indie-auth*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/indie-auth/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CLIENT: value: error: message: No such client code: NO_SUCH_CLIENT id: 02c4e690-af0c-4dc9-9f2f-c436c3b2782d INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/indie-auth/list: post: operationId: post___admin___indie-auth___list summary: admin/indie-auth/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:indie-auth*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/indie-auth/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string createdAt: type: string format: date-time name: type: - string - 'null' redirectUris: type: array items: type: string required: - id - createdAt - name - redirectUris '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/indie-auth/update: post: operationId: post___admin___indie-auth___update summary: admin/indie-auth/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:indie-auth*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/indie-auth/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string minLength: 1 name: type: - string - 'null' redirectUris: type: array minItems: 1 items: type: string required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CLIENT: value: error: message: No such client code: NO_SUCH_CLIENT id: d4f9440a-45aa-495c-af66-b4d1e339d4fc INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/invite/create: post: operationId: post___admin___invite___create summary: admin/invite/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:invite-codes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/invite/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: count: type: integer minimum: 1 maximum: 100 default: 1 expiresAt: type: - string - 'null' responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/InviteCode' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_DATE_TIME: value: error: message: Invalid date-time format code: INVALID_DATE_TIME id: f1380b15-3760-4c6c-a1db-5c3aaf1cbd49 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/invite/list: post: operationId: post___admin___invite___list summary: admin/invite/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:invite-codes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/invite/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 30 offset: type: integer default: 0 type: type: string enum: - unused - used - expired - all default: all sort: type: string enum: - +createdAt - -createdAt - +usedAt - -usedAt responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/InviteCode' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/promo/create: post: operationId: post___admin___promo___create summary: admin/promo/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:promo*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/promo/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id expiresAt: type: integer required: - noteId - expiresAt responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_NOTE: value: error: message: No such note. code: NO_SUCH_NOTE id: ee449fbe-af2a-453b-9cae-cf2fe7c895fc ALREADY_PROMOTED: value: error: message: The note has already promoted. code: ALREADY_PROMOTED id: ae427aa2-7a41-484f-a18c-2c1104051604 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/queue/clear: post: operationId: post___admin___queue___clear summary: admin/queue/clear description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:queue*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/queue/clear.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: type: type: string enum: - system - endedPollNotification - deliver - inbox - db - relationship - objectStorage - userWebhookDeliver - systemWebhookDeliver state: type: string enum: - '*' - wait - delayed required: - type - state responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/queue/deliver-delayed: post: operationId: post___admin___queue___deliver-delayed summary: admin/queue/deliver-delayed description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:queue*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/queue/deliver-delayed.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: array prefixItems: - type: string - type: number unevaluatedItems: false example: - - example.com - 12 '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/queue/inbox-delayed: post: operationId: post___admin___queue___inbox-delayed summary: admin/queue/inbox-delayed description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:queue*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/queue/inbox-delayed.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: array prefixItems: - type: string - type: number unevaluatedItems: false example: - - example.com - 12 '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/queue/promote: post: operationId: post___admin___queue___promote summary: admin/queue/promote description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:queue*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/queue/promote.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: type: type: string enum: - deliver - inbox required: - type responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/queue/stats: post: operationId: post___admin___queue___stats summary: admin/queue/stats description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/queue/stats.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: object properties: deliver: $ref: '#/components/schemas/QueueCount' inbox: $ref: '#/components/schemas/QueueCount' db: $ref: '#/components/schemas/QueueCount' objectStorage: $ref: '#/components/schemas/QueueCount' required: - deliver - inbox - db - objectStorage '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/regenerate-user-token: post: operationId: post___admin___regenerate-user-token summary: admin/regenerate-user-token description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:regenerate-user-token*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/regenerate-user-token.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/relays/add: post: operationId: post___admin___relays___add summary: admin/relays/add description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:relays*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/relays/add.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: inbox: type: string required: - inbox responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string format: id inbox: type: string format: url status: type: string default: requesting enum: - requesting - accepted - rejected required: - id - inbox - status '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_URL: value: error: message: Invalid URL code: INVALID_URL id: fb8c92d3-d4e5-44e7-b3d4-800d5cef8b2c INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/relays/list: post: operationId: post___admin___relays___list summary: admin/relays/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:relays*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/relays/list.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id inbox: type: string format: url status: type: string default: requesting enum: - requesting - accepted - rejected required: - id - inbox - status '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/relays/remove: post: operationId: post___admin___relays___remove summary: admin/relays/remove description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:relays*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/relays/remove.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: inbox: type: string required: - inbox responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/reset-password: post: operationId: post___admin___reset-password summary: admin/reset-password description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:reset-password*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/reset-password.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '200': description: OK (with results) content: application/json: schema: type: object properties: password: type: string minLength: 8 maxLength: 8 required: - password '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/resolve-abuse-user-report: post: operationId: post___admin___resolve-abuse-user-report summary: admin/resolve-abuse-user-report description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:resolve-abuse-user-report*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/resolve-abuse-user-report.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: reportId: type: string format: misskey:id resolvedAs: type: - string - 'null' enum: - accept - reject - null forward: type: boolean default: false required: - reportId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ABUSE_REPORT: value: error: message: No such abuse report. code: NO_SUCH_ABUSE_REPORT id: ac3794dd-2ce4-d878-e546-73c60c06b398 kind: server httpStatusCode: 404 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/assign: post: operationId: post___admin___roles___assign summary: admin/roles/assign description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/assign.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: roleId: type: string format: misskey:id userId: type: string format: misskey:id memo: type: string expiresAt: type: - integer - 'null' required: - roleId - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ROLE: value: error: message: No such role. code: NO_SUCH_ROLE id: 6503c040-6af4-4ed9-bf07-f2dd16678eab NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 558ea170-f653-4700-94d0-5a818371d0df ALREADY_ASSIGNED: value: error: message: User is already assigned to this role. code: ALREADY_ASSIGNED id: 67d8689c-25c6-435f-8ced-631e4b81fce1 ACCESS_DENIED: value: error: message: Only administrators can edit members of the role. code: ACCESS_DENIED id: 25b5bc31-dc79-4ebd-9bd2-c84978fd052c INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/create: post: operationId: post___admin___roles___create summary: admin/roles/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: type: string color: type: - string - 'null' iconUrl: type: - string - 'null' target: type: string enum: - manual - conditional condFormula: type: object isPublic: type: boolean isModerator: type: boolean isAdministrator: type: boolean isExplorable: type: boolean default: false asBadge: type: boolean badgeBehavior: type: - string - 'null' preserveAssignmentOnMoveAccount: type: boolean canEditMembersByModerator: type: boolean displayOrder: type: number policies: type: object required: - name - description - color - iconUrl - target - condFormula - isPublic - isModerator - isAdministrator - asBadge - canEditMembersByModerator - displayOrder - policies responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/Role' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/delete: post: operationId: post___admin___roles___delete summary: admin/roles/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: roleId: type: string format: misskey:id required: - roleId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ROLE: value: error: message: No such role. code: NO_SUCH_ROLE id: de0d6ecd-8e0a-4253-88ff-74bc89ae3d45 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/list: post: operationId: post___admin___roles___list summary: admin/roles/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/list.ts tags: - Admin security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Role' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/show: post: operationId: post___admin___roles___show summary: admin/roles/show description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/show.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: roleId: type: string format: misskey:id required: - roleId responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/Role' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ROLE: value: error: message: No such role. code: NO_SUCH_ROLE id: 07dc7d34-c0d8-49b7-96c6-db3ce64ee0b3 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/unassign: post: operationId: post___admin___roles___unassign summary: admin/roles/unassign description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/unassign.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: roleId: type: string format: misskey:id userId: type: string format: misskey:id required: - roleId - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ROLE: value: error: message: No such role. code: NO_SUCH_ROLE id: 6e519036-a70d-4c76-b679-bc8fb18194e2 NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 2b730f78-1179-461b-88ad-d24c9af1a5ce NOT_ASSIGNED: value: error: message: User was not assigned to this role. code: NOT_ASSIGNED id: b9060ac7-5c94-4da4-9f55-2047c953df44 ACCESS_DENIED: value: error: message: Only administrators can edit members of the role. code: ACCESS_DENIED id: 24636eee-e8c1-493e-94b2-e16ad401e262 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/update: post: operationId: post___admin___roles___update summary: admin/roles/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: roleId: type: string format: misskey:id name: type: string description: type: string color: type: - string - 'null' iconUrl: type: - string - 'null' target: type: string enum: - manual - conditional condFormula: type: object isPublic: type: boolean isModerator: type: boolean isAdministrator: type: boolean isExplorable: type: boolean asBadge: type: boolean badgeBehavior: type: - string - 'null' preserveAssignmentOnMoveAccount: type: boolean canEditMembersByModerator: type: boolean displayOrder: type: number policies: type: object required: - roleId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ROLE: value: error: message: No such role. code: NO_SUCH_ROLE id: cd23ef55-09ad-428a-ac61-95a45e124b32 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/update-default-policies: post: operationId: post___admin___roles___update-default-policies summary: admin/roles/update-default-policies description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/update-default-policies.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: policies: type: object required: - policies responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/update-inline-policies: post: operationId: post___admin___roles___update-inline-policies summary: admin/roles/update-inline-policies description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/update-inline-policies.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id policies: type: array items: type: object properties: id: type: - string - 'null' policy: type: string enum: - gtlAvailable - ltlAvailable - canPublicNote - canScheduleNote - scheduleNoteLimit - scheduleNoteMaxDays - canInitiateConversation - canCreateContent - canUpdateContent - canDeleteContent - canPurgeAccount - canUpdateAvatar - canUpdateBanner - mentionLimit - canInvite - inviteLimit - inviteLimitCycle - inviteExpirationTime - canManageCustomEmojis - canManageAvatarDecorations - canSearchNotes - canUseTranslator - canUseDriveFileInSoundSettings - canUseReaction - canHideAds - driveCapacityMb - maxFileSizeMb - alwaysMarkNsfw - canUpdateBioMedia - skipNsfwDetection - pinLimit - antennaLimit - antennaNotesLimit - wordMuteLimit - webhookLimit - clipLimit - noteEachClipsLimit - userListLimit - userEachUserListsLimit - rateLimitFactor - avatarDecorationLimit - canImportAntennas - canImportBlocking - canImportFollowing - canImportMuting - canImportUserLists - mutualLinkSectionLimit - mutualLinkLimit - chatAvailability operation: type: string enum: - set - increment default: set value: oneOf: - type: boolean - type: number - type: string - type: 'null' memo: type: - string - 'null' required: - policy required: - userId - policies responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: f5b42979-e8e7-4027-9022-3e507ad29828 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/roles/users: post: operationId: post___admin___roles___users summary: admin/roles/users description: 'No description provided. **Credential required**: *No* / **Permission**: *read:admin:roles*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/roles/users.ts tags: - Admin requestBody: required: true content: application/json: schema: type: object properties: roleId: type: string format: misskey:id sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 required: - roleId responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: misskey:id createdAt: type: string format: date-time user: $ref: '#/components/schemas/UserDetailed' memo: type: - string - 'null' expiresAt: type: - string - 'null' format: date-time required: - id - createdAt - user - memo - expiresAt '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ROLE: value: error: message: No such role. code: NO_SUCH_ROLE id: 224eff5e-2488-4b18-b3e7-f50d94421648 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/send-email: post: operationId: post___admin___send-email summary: admin/send-email description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:send-email*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/send-email.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: to: type: string subject: type: string text: type: string required: - to - subject - text responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/show-moderation-logs: post: operationId: post___admin___show-moderation-logs summary: admin/show-moderation-logs description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:show-moderation-log*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/show-moderation-logs.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id type: type: - string - 'null' userId: type: - string - 'null' format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string info: type: object userId: type: string format: id user: type: object $ref: '#/components/schemas/UserDetailed' required: - id - createdAt - type - info - userId - user '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/show-user: post: operationId: post___admin___show-user summary: admin/show-user description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:show-user*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/show-user.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '200': description: OK (with results) content: application/json: schema: type: object properties: email: type: - string - 'null' emailVerified: type: boolean followedMessage: type: - string - 'null' autoAcceptFollowed: type: boolean noCrawle: type: boolean preventAiLearning: type: boolean alwaysMarkNsfw: type: boolean autoSensitive: type: boolean carefulBot: type: boolean injectFeaturedNote: type: boolean receiveAnnouncementEmail: type: boolean mutedWords: type: array items: anyOf: - type: string - type: array items: type: string mutedInstances: type: array items: type: string notificationRecieveConfig: type: object properties: note: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId follow: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId mention: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reply: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId renote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId quote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reaction: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId pollEnded: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId receiveFollowRequest: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId followRequestAccepted: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId roleAssigned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId chatRoomInvitationReceived: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId achievementEarned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId app: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId test: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId isModerator: type: boolean isSilenced: type: boolean isLimited: type: boolean isDeleted: type: boolean isSuspended: type: boolean isHibernated: type: boolean lastActiveDate: type: - string - 'null' moderationNote: type: string signins: type: array items: $ref: '#/components/schemas/Signin' policies: type: object $ref: '#/components/schemas/RolePolicies' roles: type: array items: type: object $ref: '#/components/schemas/Role' roleAssigns: type: array items: type: object properties: createdAt: type: string expiresAt: type: - string - 'null' roleId: type: string memo: type: - string - 'null' required: - createdAt - expiresAt - roleId - memo inlinePolicies: type: array items: type: object properties: id: type: string createdAt: type: string updatedAt: type: string policy: type: string operation: type: string value: oneOf: - type: boolean - type: number - type: string - type: 'null' memo: type: - string - 'null' required: - id - createdAt - updatedAt - policy - operation - value - memo required: - email - emailVerified - followedMessage - autoAcceptFollowed - noCrawle - preventAiLearning - alwaysMarkNsfw - autoSensitive - carefulBot - injectFeaturedNote - receiveAnnouncementEmail - mutedWords - mutedInstances - notificationRecieveConfig - isModerator - isSilenced - isLimited - isDeleted - isSuspended - isHibernated - lastActiveDate - moderationNote - signins - policies - roles - roleAssigns - inlinePolicies '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/show-user-account-move-logs: post: operationId: post___admin___show-user-account-move-logs summary: admin/show-user-account-move-logs description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:show-account-move-log*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/show-user-account-move-logs.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id movedFromId: type: - string - 'null' format: misskey:id movedToId: type: - string - 'null' format: misskey:id from: type: - string - 'null' enum: - local - remote - all to: type: - string - 'null' enum: - local - remote - all responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id createdAt: type: string format: date-time movedToId: type: string format: id movedTo: type: object $ref: '#/components/schemas/UserDetailed' movedFromId: type: string format: id movedFrom: type: object $ref: '#/components/schemas/UserDetailed' required: - id - createdAt - movedToId - movedTo - movedFromId - movedFrom '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/show-users: post: operationId: post___admin___show-users summary: admin/show-users description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:show-user*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/show-users.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 sort: type: string enum: - +follower - -follower - +createdAt - -createdAt - +updatedAt - -updatedAt - +lastActiveDate - -lastActiveDate state: type: string enum: - all - alive - available - admin - moderator - adminOrModerator - suspended default: all origin: type: string enum: - combined - local - remote default: combined username: type: - string - 'null' default: null hostname: type: - string - 'null' default: null description: The local host is represented with `null`. responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/UserDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/sso/create: post: operationId: post___admin___sso___create summary: admin/sso/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:sso*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/sso/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: - string - 'null' type: type: string enum: - saml - jwt issuer: type: string audience: type: array items: type: string default: [] binding: type: string enum: - post - redirect acsUrl: type: string signatureAlgorithm: type: string cipherAlgorithm: type: - string - 'null' wantAuthnRequestsSigned: type: boolean default: false wantAssertionsSigned: type: boolean default: true wantEmailAddressNormalized: type: boolean default: true useCertificate: type: boolean default: true secret: type: - string - 'null' required: - type - issuer - acsUrl - signatureAlgorithm - useCertificate responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string createdAt: type: string format: date-time name: type: - string - 'null' type: type: string enum: - saml - jwt issuer: type: string audience: type: array items: type: string binding: type: string enum: - post - redirect acsUrl: type: string publicKey: type: string signatureAlgorithm: type: string cipherAlgorithm: type: - string - 'null' wantAuthnRequestsSigned: type: boolean wantAssertionsSigned: type: boolean wantEmailAddressNormalized: type: boolean required: - id - createdAt - name - type - issuer - audience - binding - acsUrl - publicKey - signatureAlgorithm - wantAuthnRequestsSigned - wantAssertionsSigned - wantEmailAddressNormalized '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/sso/delete: post: operationId: post___admin___sso___delete summary: admin/sso/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:sso*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/sso/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_SSO_SP: value: error: message: No such SSO Service Provider code: NO_SUCH_SSO_SP id: ece541d3-6c41-4fc3-a514-fa762b96704a INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/sso/list: post: operationId: post___admin___sso___list summary: admin/sso/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:sso*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/sso/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string createdAt: type: string format: date-time name: type: - string - 'null' type: type: string enum: - saml - jwt issuer: type: string audience: type: array items: type: string binding: type: string enum: - post - redirect acsUrl: type: string useCertificate: type: boolean publicKey: type: string signatureAlgorithm: type: string cipherAlgorithm: type: - string - 'null' wantAuthnRequestsSigned: type: boolean wantAssertionsSigned: type: boolean wantEmailAddressNormalized: type: boolean required: - id - createdAt - name - type - issuer - audience - binding - acsUrl - useCertificate - publicKey - signatureAlgorithm - wantAuthnRequestsSigned - wantAssertionsSigned - wantEmailAddressNormalized '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/sso/update: post: operationId: post___admin___sso___update summary: admin/sso/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:sso*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/sso/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string name: type: - string - 'null' issuer: type: string audience: type: array items: type: string binding: type: string enum: - post - redirect acsUrl: type: string signatureAlgorithm: type: string cipherAlgorithm: type: - string - 'null' wantAuthnRequestsSigned: type: boolean wantAssertionsSigned: type: boolean wantEmailAddressNormalized: type: boolean regenerateCertificate: type: - boolean - 'null' secret: type: - string - 'null' required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_SSO_SP: value: error: message: No such SSO Service Provider code: NO_SUCH_SSO_SP id: 2f481db0-23f5-4380-8cb8-704169ffb25b INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/suspend-user: post: operationId: post___admin___suspend-user summary: admin/suspend-user description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:suspend-user*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/suspend-user.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/system-webhook/create: post: operationId: post___admin___system-webhook___create summary: admin/system-webhook/create description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/system-webhook/create.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: isActive: type: boolean name: type: string minLength: 1 maxLength: 255 'on': type: array items: type: string enum: - abuseReport - abuseReportResolved - userCreated - inactiveModeratorsWarning - inactiveModeratorsInvitationOnlyChanged - reportAutoResolved url: type: string minLength: 1 maxLength: 1024 secret: type: string minLength: 1 maxLength: 1024 required: - isActive - name - 'on' - url - secret responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/SystemWebhook' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/system-webhook/delete: post: operationId: post___admin___system-webhook___delete summary: admin/system-webhook/delete description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/system-webhook/delete.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/system-webhook/list: post: operationId: post___admin___system-webhook___list summary: admin/system-webhook/list description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/system-webhook/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: isActive: type: boolean 'on': type: array items: type: string enum: - abuseReport - abuseReportResolved - userCreated - inactiveModeratorsWarning - inactiveModeratorsInvitationOnlyChanged - reportAutoResolved responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/SystemWebhook' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/system-webhook/show: post: operationId: post___admin___system-webhook___show summary: admin/system-webhook/show description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/system-webhook/show.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/SystemWebhook' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_SYSTEM_WEBHOOK: value: error: message: No such SystemWebhook. code: NO_SUCH_SYSTEM_WEBHOOK id: 38dd1ffe-04b4-6ff5-d8ba-4e6a6ae22c9d kind: server httpStatusCode: 404 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/system-webhook/update: post: operationId: post___admin___system-webhook___update summary: admin/system-webhook/update description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes* / **Permission**: *write:admin:system-webhook*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/system-webhook/update.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id isActive: type: boolean name: type: string minLength: 1 maxLength: 255 'on': type: array items: type: string enum: - abuseReport - abuseReportResolved - userCreated - inactiveModeratorsWarning - inactiveModeratorsInvitationOnlyChanged - reportAutoResolved url: type: string minLength: 1 maxLength: 1024 secret: type: string minLength: 1 maxLength: 1024 required: - id - isActive - name - 'on' - url - secret responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/SystemWebhook' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/unset-user-avatar: post: operationId: post___admin___unset-user-avatar summary: admin/unset-user-avatar description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:user-avatar*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/unset-user-avatar.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/unset-user-banner: post: operationId: post___admin___unset-user-banner summary: admin/unset-user-banner description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:user-banner*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/unset-user-banner.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/unset-user-mutual-link: post: operationId: post___admin___unset-user-mutual-link summary: admin/unset-user-mutual-link description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:user-mutual-link*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/unset-user-mutual-link.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id itemId: type: string format: misskey:id required: - userId - itemId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/unsuspend-user: post: operationId: post___admin___unsuspend-user summary: admin/unsuspend-user description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:unsuspend-user*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/unsuspend-user.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/update-abuse-user-report: post: operationId: post___admin___update-abuse-user-report summary: admin/update-abuse-user-report description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:resolve-abuse-user-report*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/update-abuse-user-report.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: reportId: type: string format: misskey:id moderationNote: type: string required: - reportId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ABUSE_REPORT: value: error: message: No such abuse report. code: NO_SUCH_ABUSE_REPORT id: 15f51cf5-46d1-4b1d-a618-b35bcbed0662 kind: server httpStatusCode: 404 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/update-meta: post: operationId: post___admin___update-meta summary: admin/update-meta description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:meta*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/update-meta.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: disableRegistration: type: - boolean - 'null' pinnedUsers: type: - array - 'null' items: type: string hiddenTags: type: - array - 'null' items: type: string blockedHosts: type: - array - 'null' items: type: string sensitiveWords: type: - array - 'null' items: type: string blockedRemoteCustomEmojis: type: - array - 'null' items: type: string prohibitedWords: type: - array - 'null' items: type: string themeColor: type: - string - 'null' pattern: ^#[0-9a-fA-F]{6}$ mascotImageUrl: type: - string - 'null' bannerUrl: type: - string - 'null' serverErrorImageUrl: type: - string - 'null' infoImageUrl: type: - string - 'null' notFoundImageUrl: type: - string - 'null' iconUrl: type: - string - 'null' app192IconUrl: type: - string - 'null' app512IconUrl: type: - string - 'null' backgroundImageUrl: type: - string - 'null' logoImageUrl: type: - string - 'null' name: type: - string - 'null' shortName: type: - string - 'null' description: type: - string - 'null' defaultLightTheme: type: - string - 'null' defaultDarkTheme: type: - string - 'null' cacheRemoteFiles: type: boolean cacheRemoteSensitiveFiles: type: boolean emailRequiredForSignup: type: boolean enableHcaptcha: type: boolean hcaptchaSiteKey: type: - string - 'null' hcaptchaSecretKey: type: - string - 'null' enableMcaptcha: type: boolean mcaptchaSiteKey: type: - string - 'null' mcaptchaInstanceUrl: type: - string - 'null' mcaptchaSecretKey: type: - string - 'null' enableRecaptcha: type: boolean recaptchaSiteKey: type: - string - 'null' recaptchaSecretKey: type: - string - 'null' enableTurnstile: type: boolean turnstileSiteKey: type: - string - 'null' turnstileSecretKey: type: - string - 'null' googleAnalyticsId: type: - string - 'null' sensitiveMediaDetection: type: string enum: - none - all - local - remote sensitiveMediaDetectionSensitivity: type: string enum: - medium - low - high - veryLow - veryHigh setSensitiveFlagAutomatically: type: boolean enableSensitiveMediaDetectionForVideos: type: boolean maintainerName: type: - string - 'null' maintainerEmail: type: - string - 'null' langs: type: array items: type: string dimensions: type: integer minimum: 1 deeplAuthKey: type: - string - 'null' deeplIsPro: type: boolean enableEmail: type: boolean email: type: - string - 'null' smtpSecure: type: boolean smtpHost: type: - string - 'null' smtpPort: type: - integer - 'null' smtpUser: type: - string - 'null' smtpPass: type: - string - 'null' enableServiceWorker: type: boolean swPublicKey: type: - string - 'null' swPrivateKey: type: - string - 'null' tosUrl: type: - string - 'null' repositoryUrl: type: - string - 'null' feedbackUrl: type: - string - 'null' impressumUrl: type: - string - 'null' privacyPolicyUrl: type: - string - 'null' useObjectStorage: type: boolean objectStorageBaseUrl: type: - string - 'null' objectStorageBucket: type: - string - 'null' objectStoragePrefix: type: - string - 'null' pattern: ^[a-zA-Z0-9-._]*$ objectStorageEndpoint: type: - string - 'null' objectStorageRegion: type: - string - 'null' objectStoragePort: type: - integer - 'null' objectStorageAccessKey: type: - string - 'null' objectStorageSecretKey: type: - string - 'null' objectStorageUseSSL: type: boolean objectStorageUseProxy: type: boolean objectStorageSetPublicRead: type: boolean objectStorageS3ForcePathStyle: type: boolean enableIpLogging: type: boolean enableActiveEmailValidation: type: boolean enableVerifymailApi: type: boolean verifymailAuthKey: type: - string - 'null' enableTruemailApi: type: boolean truemailInstance: type: - string - 'null' truemailAuthKey: type: - string - 'null' enableChartsForRemoteUser: type: boolean enableChartsForFederatedInstances: type: boolean enableServerMachineStats: type: boolean enableIdenticonGeneration: type: boolean serverRules: type: array items: type: string bannedEmailDomains: type: array items: type: string preservedUsernames: type: array items: type: string manifestJsonOverride: type: string enableFanoutTimeline: type: boolean enableFanoutTimelineDbFallback: type: boolean perLocalUserUserTimelineCacheMax: type: integer perRemoteUserUserTimelineCacheMax: type: integer perUserHomeTimelineCacheMax: type: integer perUserListTimelineCacheMax: type: integer notesPerOneAd: type: integer silencedHosts: type: - array - 'null' items: type: string sensitiveMediaHosts: type: - array - 'null' items: type: string wellKnownWebsites: type: - array - 'null' items: type: string urlPreviewDenyList: type: - array - 'null' items: type: string featuredGameChannels: type: - array - 'null' items: type: string summalyProxy: type: - string - 'null' description: '[Deprecated] Use "urlPreviewSummaryProxyUrl" instead.' urlPreviewEnabled: type: boolean urlPreviewTimeout: type: integer urlPreviewMaximumContentLength: type: integer urlPreviewRequireContentLength: type: boolean urlPreviewUserAgent: type: - string - 'null' urlPreviewSummaryProxyUrl: type: - string - 'null' prohibitedWordsForNameOfUser: type: - array - 'null' items: type: string federation: type: string enum: - all - none - specified federationHosts: type: array items: type: string responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/update-proxy-account: post: operationId: post___admin___update-proxy-account summary: admin/update-proxy-account description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/update-proxy-account.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: description: type: - string - 'null' minLength: 1 maxLength: 1500 responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/UserDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/update-user-name: post: operationId: post___admin___update-user-name summary: admin/update-user-name description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:user-name*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/update-user-name.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id name: type: string required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /admin/update-user-note: post: operationId: post___admin___update-user-note summary: admin/update-user-note description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:admin:user-note*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/update-user-note.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id text: type: string required: - userId - text responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /v2/admin/emoji/list: post: operationId: post___v2___admin___emoji___list summary: v2/admin/emoji/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:admin:emoji*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/v2/admin/emoji/list.ts tags: - Admin security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: query: type: - object - 'null' properties: updatedAtFrom: type: string updatedAtTo: type: string name: type: string host: type: string uri: type: string publicUrl: type: string originalUrl: type: string type: type: string aliases: type: string category: type: string license: type: string isSensitive: type: boolean localOnly: type: boolean hostType: type: string enum: - local - remote - all default: all roleIds: type: array items: type: string format: misskey:id sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 page: type: integer sortKeys: type: array default: - -id items: type: string enum: - +id - -id - +updatedAt - -updatedAt - +name - -name - +host - -host - +uri - -uri - +publicUrl - -publicUrl - +type - -type - +aliases - -aliases - +category - -category - +license - -license - +isSensitive - -isSensitive - +localOnly - -localOnly - +roleIdsThatCanBeUsedThisEmojiAsReaction - -roleIdsThatCanBeUsedThisEmojiAsReaction responses: '200': description: OK (with results) content: application/json: schema: type: object properties: emojis: type: array items: type: object $ref: '#/components/schemas/EmojiDetailedAdmin' count: type: integer allCount: type: integer allPages: type: integer required: - emojis - count - allCount - allPages '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac components: schemas: Signin: type: object properties: id: type: string createdAt: type: string format: date-time ip: type: string headers: type: object success: type: boolean required: - id - createdAt - ip - headers - success RolePolicies: type: object properties: gtlAvailable: type: boolean ltlAvailable: type: boolean canPublicNote: type: boolean canScheduleNote: type: boolean scheduleNoteLimit: type: integer scheduleNoteMaxDays: type: integer canInitiateConversation: type: boolean canCreateContent: type: boolean canUpdateContent: type: boolean canDeleteContent: type: boolean canPurgeAccount: type: boolean canUpdateAvatar: type: boolean canUpdateBanner: type: boolean mentionLimit: type: integer canInvite: type: boolean inviteLimit: type: integer inviteLimitCycle: type: integer inviteExpirationTime: type: integer canManageCustomEmojis: type: boolean canManageAvatarDecorations: type: boolean canSearchNotes: type: boolean canUseTranslator: type: boolean canUseDriveFileInSoundSettings: type: boolean canUseReaction: type: boolean canHideAds: type: boolean driveCapacityMb: type: integer maxFileSizeMb: type: integer alwaysMarkNsfw: type: boolean skipNsfwDetection: type: boolean canUpdateBioMedia: type: boolean pinLimit: type: integer antennaLimit: type: integer antennaNotesLimit: type: integer wordMuteLimit: type: integer webhookLimit: type: integer clipLimit: type: integer noteEachClipsLimit: type: integer userListLimit: type: integer userEachUserListsLimit: type: integer rateLimitFactor: type: integer avatarDecorationLimit: type: integer canImportAntennas: type: boolean canImportBlocking: type: boolean canImportFollowing: type: boolean canImportMuting: type: boolean canImportUserLists: type: boolean mutualLinkSectionLimit: type: integer mutualLinkLimit: type: integer chatAvailability: type: string enum: - available - readonly - unavailable required: - gtlAvailable - ltlAvailable - canPublicNote - canScheduleNote - scheduleNoteLimit - scheduleNoteMaxDays - canInitiateConversation - canCreateContent - canUpdateContent - canDeleteContent - canPurgeAccount - canUpdateAvatar - canUpdateBanner - mentionLimit - canInvite - inviteLimit - inviteLimitCycle - inviteExpirationTime - canManageCustomEmojis - canManageAvatarDecorations - canSearchNotes - canUseTranslator - canUseDriveFileInSoundSettings - canUseReaction - canHideAds - driveCapacityMb - maxFileSizeMb - alwaysMarkNsfw - skipNsfwDetection - canUpdateBioMedia - pinLimit - antennaLimit - antennaNotesLimit - wordMuteLimit - webhookLimit - clipLimit - noteEachClipsLimit - userListLimit - userEachUserListsLimit - rateLimitFactor - avatarDecorationLimit - canImportAntennas - canImportBlocking - canImportFollowing - canImportMuting - canImportUserLists - mutualLinkSectionLimit - mutualLinkLimit - chatAvailability RoleCondFormulaValue: type: object oneOf: - $ref: '#/components/schemas/RoleCondFormulaLogics' - $ref: '#/components/schemas/RoleCondFormulaValueNot' - $ref: '#/components/schemas/RoleCondFormulaValueIsLocalOrRemote' - $ref: '#/components/schemas/RoleCondFormulaValueUserSettingBooleanSchema' - $ref: '#/components/schemas/RoleCondFormulaValueAssignedRole' - $ref: '#/components/schemas/RoleCondFormulaValueCreated' - $ref: '#/components/schemas/RoleCondFormulaFollowersOrFollowingOrNotes' DriveFile: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string example: 192.jpg type: type: string example: image/jpeg md5: type: string format: md5 example: 15eca7fba0480996e2245f5185bf39f2 size: type: number example: 51469 isSensitive: type: boolean isSensitiveByModerator: type: - boolean - 'null' blurhash: type: - string - 'null' properties: type: object properties: width: type: number example: 1280 height: type: number example: 720 orientation: type: number example: 8 avgColor: type: string example: rgb(40,65,87) url: type: string format: url thumbnailUrl: type: - string - 'null' format: url comment: type: - string - 'null' folderId: type: - string - 'null' format: id example: xxxxxxxxxx folder: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' userId: type: - string - 'null' format: id example: xxxxxxxxxx user: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' required: - id - createdAt - name - type - md5 - size - isSensitive - blurhash - properties - url - thumbnailUrl - comment - folderId - userId Note: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time deletedAt: type: - string - 'null' format: date-time text: type: - string - 'null' cw: type: - string - 'null' userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' replyId: type: - string - 'null' format: id example: xxxxxxxxxx renoteId: type: - string - 'null' format: id example: xxxxxxxxxx reply: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' renote: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' isHidden: type: boolean visibility: type: string enum: - public - home - followers - specified mentions: type: array items: type: string format: id visibleUserIds: type: array items: type: string format: id fileIds: type: array items: type: string format: id files: type: array items: type: object $ref: '#/components/schemas/DriveFile' tags: type: array items: type: string poll: type: - object - 'null' properties: expiresAt: type: - string - 'null' format: date-time multiple: type: boolean choices: type: array items: type: object properties: isVoted: type: boolean text: type: string votes: type: number required: - isVoted - text - votes required: - multiple - choices emojis: type: object additionalProperties: anyOf: - type: string channelId: type: - string - 'null' format: id example: xxxxxxxxxx channel: type: - object - 'null' properties: id: type: string name: type: string color: type: string isSensitive: type: boolean allowRenoteToExternal: type: boolean userId: type: - string - 'null' required: - id - name - color - isSensitive - allowRenoteToExternal - userId localOnly: type: boolean dimension: type: - integer - 'null' reactionAcceptance: type: - string - 'null' enum: - likeOnly - likeOnlyForRemote - nonSensitiveOnly - nonSensitiveOnlyForLocalLikeOnlyForRemote - null reactionEmojis: type: object additionalProperties: anyOf: - type: string reactions: type: object additionalProperties: anyOf: - type: number reactionCount: type: number renoteCount: type: number repliesCount: type: number uri: type: string url: type: string reactionAndUserPairCache: type: array items: type: string clippedCount: type: number myReaction: type: - string - 'null' required: - id - createdAt - text - userId - user - visibility - reactionAcceptance - reactionEmojis - reactions - reactionCount - renoteCount - repliesCount UserDetailed: oneOf: - type: object $ref: '#/components/schemas/UserDetailedNotMe' - type: object $ref: '#/components/schemas/MeDetailed' RoleCondFormulaValueIsLocalOrRemote: type: object properties: id: type: string type: type: string enum: - isLocal - isRemote required: - id - type RoleCondFormulaValueCreated: type: object properties: id: type: string type: type: string enum: - createdLessThan - createdMoreThan sec: type: number required: - id - type - sec Page: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: string format: date-time userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' content: type: array items: type: object $ref: '#/components/schemas/PageBlock' variables: type: array items: type: object title: type: string name: type: string summary: type: - string - 'null' hideTitleWhenPinned: type: boolean alignCenter: type: boolean font: type: string script: type: string eyeCatchingImageId: type: - string - 'null' eyeCatchingImage: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFile' - type: 'null' attachedFiles: type: array items: type: object $ref: '#/components/schemas/DriveFile' likedCount: type: number isLiked: type: boolean visibility: type: string enum: - public - private required: - id - createdAt - updatedAt - userId - user - content - variables - title - name - summary - hideTitleWhenPinned - alignCenter - font - script - eyeCatchingImageId - eyeCatchingImage - attachedFiles - likedCount - visibility Role: type: object allOf: - type: object $ref: '#/components/schemas/RoleLite' - type: object properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time target: type: string enum: - manual - conditional condFormula: type: object $ref: '#/components/schemas/RoleCondFormulaValue' isPublic: type: boolean example: false isExplorable: type: boolean example: false asBadge: type: boolean example: false preserveAssignmentOnMoveAccount: type: boolean example: false badgeBehavior: type: - string - 'null' canEditMembersByModerator: type: boolean example: false policies: type: object additionalProperties: anyOf: - type: object properties: value: oneOf: - type: integer - type: boolean priority: type: integer useDefault: type: boolean usersCount: type: integer required: - createdAt - updatedAt - target - condFormula - isPublic - isExplorable - asBadge - preserveAssignmentOnMoveAccount - badgeBehavior - canEditMembersByModerator - policies - usersCount UserDetailedNotMeOnly: type: object properties: url: type: - string - 'null' format: url uri: type: - string - 'null' format: uri movedTo: type: - string - 'null' format: uri alsoKnownAs: type: - array - 'null' items: type: string format: id createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time lastFetchedAt: type: - string - 'null' format: date-time bannerUrl: type: - string - 'null' format: url bannerBlurhash: type: - string - 'null' isLocked: type: boolean isSilenced: type: boolean isLimited: type: boolean isSuspended: type: boolean example: false description: type: - string - 'null' example: Hi masters, I am Ai! location: type: - string - 'null' birthday: type: - string - 'null' example: '2018-03-12' lang: type: - string - 'null' example: ja-JP fields: type: array maxItems: 16 items: type: object properties: name: type: string value: type: string required: - name - value verifiedLinks: type: array items: type: string format: url followersCount: type: number followingCount: type: number notesCount: type: number pinnedNoteIds: type: array items: type: string format: id pinnedNotes: type: array items: type: object $ref: '#/components/schemas/Note' pinnedPageId: type: - string - 'null' pinnedPage: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Page' - type: 'null' publicReactions: type: boolean followingVisibility: type: string enum: - public - followers - private followersVisibility: type: string enum: - public - followers - private chatScope: type: string enum: - everyone - following - followers - mutual - none canChat: type: boolean roles: type: array items: type: object $ref: '#/components/schemas/RoleLite' followedMessage: type: - string - 'null' memo: type: - string - 'null' moderationNote: type: string twoFactorEnabled: type: boolean usePasswordLessLogin: type: boolean securityKeys: type: boolean mutualLinkSections: type: array items: type: object properties: name: type: - string - 'null' mutualLinks: type: array items: type: object properties: id: type: string format: misskey:id url: type: string format: url fileId: type: string format: misskey:id description: type: - string - 'null' imgSrc: type: string required: - id - url - fileId - description - imgSrc required: - name - mutualLinks isFollowing: type: boolean isFollowed: type: boolean hasPendingFollowRequestFromYou: type: boolean hasPendingFollowRequestToYou: type: boolean isBlocking: type: boolean isBlocked: type: boolean isMuted: type: boolean isRenoteMuted: type: boolean notify: type: string enum: - normal - none withReplies: type: boolean required: - url - uri - movedTo - alsoKnownAs - createdAt - updatedAt - lastFetchedAt - bannerUrl - bannerBlurhash - isLocked - isSilenced - isLimited - isSuspended - description - location - birthday - lang - fields - verifiedLinks - followersCount - followingCount - notesCount - pinnedNoteIds - pinnedNotes - pinnedPageId - pinnedPage - publicReactions - followingVisibility - followersVisibility - chatScope - canChat - roles - memo - mutualLinkSections UserDetailedNotMe: type: object allOf: - type: object $ref: '#/components/schemas/UserLite' - type: object $ref: '#/components/schemas/UserDetailedNotMeOnly' RoleCondFormulaFollowersOrFollowingOrNotes: type: object properties: id: type: string type: type: string enum: - followersLessThanOrEq - followersMoreThanOrEq - followingLessThanOrEq - followingMoreThanOrEq - notesLessThanOrEq - notesMoreThanOrEq value: type: number required: - id - type - value InviteCode: type: object properties: id: type: string format: id example: xxxxxxxxxx code: type: string example: GR6S02ERUA5VR expiresAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time createdBy: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' usedBy: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' usedAt: type: - string - 'null' format: date-time used: type: boolean required: - id - code - expiresAt - createdAt - createdBy - usedBy - usedAt - used RoleCondFormulaValueAssignedRole: type: object properties: id: type: string type: type: string enum: - roleAssignedTo roleId: type: string format: id example: xxxxxxxxxx required: - id - type - roleId Announcement: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time text: type: string title: type: string imageUrl: type: - string - 'null' icon: type: string enum: - info - warning - error - success display: type: string enum: - dialog - normal - banner needConfirmationToRead: type: boolean needEnrollmentTutorialToRead: type: boolean forYou: type: boolean closeDuration: type: number displayOrder: type: number silence: type: boolean isRead: type: boolean required: - id - createdAt - updatedAt - text - title - imageUrl - icon - display - needConfirmationToRead - needEnrollmentTutorialToRead - forYou - closeDuration - displayOrder - silence RoleCondFormulaLogics: type: object properties: id: type: string type: type: string enum: - and - or values: type: array items: $ref: '#/components/schemas/RoleCondFormulaValue' required: - id - type - values DriveFolder: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string parentId: type: - string - 'null' format: id example: xxxxxxxxxx foldersCount: type: number filesCount: type: number parent: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' required: - id - createdAt - name - parentId UserLite: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: - string - 'null' example: 藍 username: type: string example: ai host: type: - string - 'null' example: misskey.example.com description: The local host is represented with `null`. avatarUrl: type: - string - 'null' format: url avatarBlurhash: type: - string - 'null' avatarDecorations: type: array items: type: object properties: id: type: string format: id angle: type: number flipH: type: boolean url: type: string format: url offsetX: type: number offsetY: type: number required: - id - url isBot: type: boolean isCat: type: boolean requireSigninToViewContents: type: boolean makeNotesFollowersOnlyBefore: type: - number - 'null' makeNotesHiddenBefore: type: - number - 'null' instance: type: object properties: name: type: - string - 'null' softwareName: type: - string - 'null' softwareVersion: type: - string - 'null' iconUrl: type: - string - 'null' faviconUrl: type: - string - 'null' themeColor: type: - string - 'null' required: - name - softwareName - softwareVersion - iconUrl - faviconUrl - themeColor emojis: type: object additionalProperties: type: string onlineStatus: type: string enum: - unknown - online - active - offline badgeRoles: type: array items: type: object properties: name: type: string iconUrl: type: - string - 'null' displayOrder: type: number behavior: type: string required: - name - iconUrl - displayOrder required: - id - name - username - host - avatarUrl - avatarBlurhash - avatarDecorations - emojis - onlineStatus Error: type: object properties: error: type: object description: An error object. properties: code: type: string description: An error code. Unique within the endpoint. message: type: string description: An error message. id: type: string format: uuid description: An error ID. This ID is static. required: - code - id - message required: - error MeDetailedOnly: type: object properties: avatarId: type: - string - 'null' format: id bannerId: type: - string - 'null' format: id followedMessage: type: - string - 'null' isModerator: type: - boolean - 'null' isAdmin: type: - boolean - 'null' injectFeaturedNote: type: boolean receiveAnnouncementEmail: type: boolean alwaysMarkNsfw: type: boolean autoSensitive: type: boolean carefulBot: type: boolean autoAcceptFollowed: type: boolean noCrawle: type: boolean preventAiLearning: type: boolean isExplorable: type: boolean isDeleted: type: boolean twoFactorBackupCodesStock: type: string enum: - full - partial - none hideOnlineStatus: type: boolean hasUnreadSpecifiedNotes: type: boolean hasUnreadMentions: type: boolean hasUnreadAnnouncement: type: boolean unreadAnnouncements: type: array items: type: object $ref: '#/components/schemas/Announcement' hasUnreadAntenna: type: boolean hasUnreadChannel: type: boolean hasUnreadChatMessages: type: boolean hasUnreadNotification: type: boolean hasPendingReceivedFollowRequest: type: boolean unreadNotificationsCount: type: number mutedWords: type: array items: type: array items: type: string mutedInstances: type: - array - 'null' items: type: string postingLang: type: - string - 'null' example: ja-JP viewingLangs: type: array items: type: string showMediaInAllLanguages: type: boolean showHashtagsInAllLanguages: type: boolean notificationRecieveConfig: type: object properties: note: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId follow: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId mention: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reply: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId renote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId quote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reaction: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId pollEnded: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId receiveFollowRequest: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId followRequestAccepted: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId roleAssigned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId chatRoomInvitationReceived: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId achievementEarned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId app: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId test: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId emailNotificationTypes: type: array items: type: string achievements: type: array items: type: object properties: name: type: string unlockedAt: type: number required: - name - unlockedAt loggedInDays: type: number policies: type: object $ref: '#/components/schemas/RolePolicies' twoFactorEnabled: type: boolean default: false usePasswordLessLogin: type: boolean default: false securityKeys: type: boolean default: false email: type: - string - 'null' emailVerified: type: - boolean - 'null' securityKeysList: type: array items: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: string lastUsed: type: string format: date-time required: - id - name - lastUsed required: - avatarId - bannerId - followedMessage - isModerator - isAdmin - injectFeaturedNote - receiveAnnouncementEmail - alwaysMarkNsfw - autoSensitive - carefulBot - autoAcceptFollowed - noCrawle - preventAiLearning - isExplorable - isDeleted - twoFactorBackupCodesStock - hideOnlineStatus - hasUnreadSpecifiedNotes - hasUnreadMentions - hasUnreadAnnouncement - unreadAnnouncements - hasUnreadAntenna - hasUnreadChannel - hasUnreadChatMessages - hasUnreadNotification - hasPendingReceivedFollowRequest - unreadNotificationsCount - mutedWords - mutedInstances - postingLang - viewingLangs - showMediaInAllLanguages - showHashtagsInAllLanguages - notificationRecieveConfig - emailNotificationTypes - achievements - loggedInDays - policies - twoFactorEnabled - usePasswordLessLogin - securityKeys QueueCount: type: object properties: waiting: type: number active: type: number completed: type: number failed: type: number delayed: type: number required: - waiting - active - completed - failed - delayed MeDetailed: type: object allOf: - type: object $ref: '#/components/schemas/UserLite' - type: object $ref: '#/components/schemas/UserDetailedNotMeOnly' - type: object $ref: '#/components/schemas/MeDetailedOnly' PageBlock: type: object oneOf: - type: object properties: id: type: string type: type: string enum: - text text: type: string required: - id - type - text - type: object properties: id: type: string type: type: string enum: - section title: type: string children: type: array items: type: object required: - id - type - title - children - type: object properties: id: type: string type: type: string enum: - image fileId: type: - string - 'null' required: - id - type - fileId - type: object properties: id: type: string type: type: string enum: - note detailed: type: boolean note: type: - string - 'null' required: - id - type - detailed - note RoleCondFormulaValueUserSettingBooleanSchema: type: object properties: id: type: string type: type: string enum: - isSuspended - isLocked - isBot - isCat - isExplorable required: - id - type RoleCondFormulaValueNot: type: object properties: id: type: string type: type: string enum: - not value: type: object $ref: '#/components/schemas/RoleCondFormulaValue' required: - id - type - value EmojiDetailedAdmin: type: object properties: id: type: string format: id updatedAt: type: - string - 'null' format: date-time name: type: string host: type: - string - 'null' description: The local host is represented with `null`. publicUrl: type: string originalUrl: type: string uri: type: - string - 'null' type: type: - string - 'null' aliases: type: array items: type: string format: id category: type: - string - 'null' license: type: - string - 'null' localOnly: type: boolean isSensitive: type: boolean roleIdsThatCanBeUsedThisEmojiAsReaction: type: array items: type: object properties: id: type: string format: misskey:id name: type: string required: - id - name required: - id - updatedAt - name - host - publicUrl - originalUrl - uri - type - aliases - category - license - localOnly - isSensitive - roleIdsThatCanBeUsedThisEmojiAsReaction EmojiDetailed: type: object properties: id: type: string format: id createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time aliases: type: array items: type: string format: id name: type: string category: type: - string - 'null' host: type: - string - 'null' description: The local host is represented with `null`. url: type: string license: type: - string - 'null' isSensitive: type: boolean localOnly: type: boolean requestedBy: type: - string - 'null' memo: type: - string - 'null' roleIdsThatCanBeUsedThisEmojiAsReaction: type: array items: type: string format: id roleIdsThatCanNotBeUsedThisEmojiAsReaction: type: array items: type: string format: id required: - id - aliases - name - category - host - url - license - isSensitive - localOnly AbuseReportNotificationRecipient: type: object properties: id: type: string isActive: type: boolean updatedAt: type: string format: date-time name: type: string method: type: string enum: - email - webhook userId: type: string user: type: object anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' systemWebhookId: type: string systemWebhook: type: object anyOf: - $ref: '#/components/schemas/SystemWebhook' - type: 'null' required: - id - isActive - updatedAt - name - method Ad: type: object properties: id: type: string format: id example: xxxxxxxxxx expiresAt: type: string format: date-time startsAt: type: string format: date-time place: type: string priority: type: string ratio: type: number url: type: string imageUrl: type: string imageBlurhash: type: - string - 'null' memo: type: string dayOfWeek: type: integer isSensitive: type: boolean required: - id - expiresAt - startsAt - place - priority - ratio - url - imageUrl - imageBlurhash - memo - dayOfWeek - isSensitive RoleLite: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: string example: New Role color: type: - string - 'null' example: '#000000' iconUrl: type: - string - 'null' description: type: string isModerator: type: boolean example: false isAdministrator: type: boolean example: false displayOrder: type: integer example: 0 required: - id - name - color - iconUrl - description - isModerator - isAdministrator - displayOrder SystemWebhook: type: object properties: id: type: string isActive: type: boolean updatedAt: type: string format: date-time latestSentAt: type: - string - 'null' format: date-time latestStatus: type: - number - 'null' name: type: string 'on': type: array items: type: string enum: - abuseReport - abuseReportResolved - userCreated - inactiveModeratorsWarning - inactiveModeratorsInvitationOnlyChanged - reportAutoResolved url: type: string secret: type: string required: - id - isActive - updatedAt - latestSentAt - latestStatus - name - 'on' - url - secret securitySchemes: bearerAuth: type: http scheme: bearer externalDocs: description: Repository url: https://github.com/MisskeyIO/misskey