POSTAPIの概要 実装を見る
No description provided.
Credential required: Yes
パラメータ
| 名前 | 型 | 既定値 |
|---|
| 任意 | disableRegistration | 真偽値 | - |
| 任意 | pinnedUsers | 配列（内容: 文字列） | - |
| 任意 | hiddenTags | 配列（内容: 文字列） | - |
| 任意 | blockedHosts | 配列（内容: 文字列） | - |
| 任意 | sensitiveWords | 配列（内容: 文字列） | - |
| 任意 | themeColor | 文字列 | - |
| 任意 | mascotImageUrl | 文字列 | - |
| 任意 | bannerUrl | 文字列 | - |
| 任意 | serverErrorImageUrl | 文字列 | - |
| 任意 | infoImageUrl | 文字列 | - |
| 任意 | notFoundImageUrl | 文字列 | - |
| 任意 | iconUrl | 文字列 | - |
| 任意 | app192IconUrl | 文字列 | - |
| 任意 | app512IconUrl | 文字列 | - |
| 任意 | backgroundImageUrl | 文字列 | - |
| 任意 | logoImageUrl | 文字列 | - |
| 任意 | name | 文字列 | - |
| 任意 | shortName | 文字列 | - |
| 任意 | description | 文字列 | - |
| 任意 | defaultLightTheme | 文字列 | - |
| 任意 | defaultDarkTheme | 文字列 | - |
| cacheRemoteFiles | 真偽値 | - |
| cacheRemoteSensitiveFiles | 真偽値 | - |
| emailRequiredForSignup | 真偽値 | - |
| enableHcaptcha | 真偽値 | - |
| 任意 | hcaptchaSiteKey | 文字列 | - |
| 任意 | hcaptchaSecretKey | 文字列 | - |
| enableRecaptcha | 真偽値 | - |
| 任意 | recaptchaSiteKey | 文字列 | - |
| 任意 | recaptchaSecretKey | 文字列 | - |
| enableTurnstile | 真偽値 | - |
| 任意 | turnstileSiteKey | 文字列 | - |
| 任意 | turnstileSecretKey | 文字列 | - |
| sensitiveMediaDetection | 文字列 | - |
| sensitiveMediaDetectionSensitivity | 文字列 | - |
| setSensitiveFlagAutomatically | 真偽値 | - |
| enableSensitiveMediaDetectionForVideos | 真偽値 | - |
| 任意 | proxyAccountId | 文字列 | - |
| 任意 | maintainerName | 文字列 | - |
| 任意 | maintainerEmail | 文字列 | - |
| langs | 配列（内容: 文字列） | - |
| 任意 | summalyProxy | 文字列 | - |
| 任意 | deeplAuthKey | 文字列 | - |
| deeplIsPro | 真偽値 | - |
| enableEmail | 真偽値 | - |
| 任意 | email | 文字列 | - |
| smtpSecure | 真偽値 | - |
| 任意 | smtpHost | 文字列 | - |
| 任意 | smtpPort | 整数 | - |
| 任意 | smtpUser | 文字列 | - |
| 任意 | smtpPass | 文字列 | - |
| enableServiceWorker | 真偽値 | - |
| 任意 | swPublicKey | 文字列 | - |
| 任意 | swPrivateKey | 文字列 | - |
| 任意 | tosUrl | 文字列 | - |
| repositoryUrl | 文字列 | - |
| feedbackUrl | 文字列 | - |
| useObjectStorage | 真偽値 | - |
| 任意 | objectStorageBaseUrl | 文字列 | - |
| 任意 | objectStorageBucket | 文字列 | - |
| 任意 | objectStoragePrefix | 文字列 | - |
| 任意 | objectStorageEndpoint | 文字列 | - |
| 任意 | objectStorageRegion | 文字列 | - |
| 任意 | objectStoragePort | 整数 | - |
| 任意 | objectStorageAccessKey | 文字列 | - |
| 任意 | objectStorageSecretKey | 文字列 | - |
| objectStorageUseSSL | 真偽値 | - |
| objectStorageUseProxy | 真偽値 | - |
| objectStorageSetPublicRead | 真偽値 | - |
| objectStorageS3ForcePathStyle | 真偽値 | - |
| enableIpLogging | 真偽値 | - |
| enableActiveEmailValidation | 真偽値 | - |
| enableChartsForRemoteUser | 真偽値 | - |
| enableChartsForFederatedInstances | 真偽値 | - |
| enableServerMachineStats | 真偽値 | - |
| enableIdenticonGeneration | 真偽値 | - |
| serverRules | 配列（内容: 文字列） | - |
| preservedUsernames | 配列（内容: 文字列） | - |
| manifestJsonOverride | 文字列 | - |
204 レスポンス リクエスト成功（内容なし）
400 エラー クライアント側エラー
401 エラー 認証エラー
403 エラー 権限関連のエラー
418 エラー I'm Ai
500 エラー サーバー内部エラー
{
"_path": "/api-docs/endpoints/admin/update-meta",
"_dir": "admin",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "admin/update-meta",
"summary": "admin/update-meta",
"description": "No description provided.\n\n**Credential required**: *Yes*",
"externalDocs": {
"description": "Source code",
"url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/update-meta.ts"
},
"tags": [
"admin"
],
"security": [
{
"ApiKeyAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"disableRegistration": {
"type": "boolean",
"nullable": true
},
"pinnedUsers": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"hiddenTags": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"blockedHosts": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"sensitiveWords": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"themeColor": {
"type": "string",
"nullable": true,
"pattern": "^#[0-9a-fA-F]{6}$"
},
"mascotImageUrl": {
"type": "string",
"nullable": true
},
"bannerUrl": {
"type": "string",
"nullable": true
},
"serverErrorImageUrl": {
"type": "string",
"nullable": true
},
"infoImageUrl": {
"type": "string",
"nullable": true
},
"notFoundImageUrl": {
"type": "string",
"nullable": true
},
"iconUrl": {
"type": "string",
"nullable": true
},
"app192IconUrl": {
"type": "string",
"nullable": true
},
"app512IconUrl": {
"type": "string",
"nullable": true
},
"backgroundImageUrl": {
"type": "string",
"nullable": true
},
"logoImageUrl": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"shortName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"defaultLightTheme": {
"type": "string",
"nullable": true
},
"defaultDarkTheme": {
"type": "string",
"nullable": true
},
"cacheRemoteFiles": {
"type": "boolean"
},
"cacheRemoteSensitiveFiles": {
"type": "boolean"
},
"emailRequiredForSignup": {
"type": "boolean"
},
"enableHcaptcha": {
"type": "boolean"
},
"hcaptchaSiteKey": {
"type": "string",
"nullable": true
},
"hcaptchaSecretKey": {
"type": "string",
"nullable": true
},
"enableRecaptcha": {
"type": "boolean"
},
"recaptchaSiteKey": {
"type": "string",
"nullable": true
},
"recaptchaSecretKey": {
"type": "string",
"nullable": true
},
"enableTurnstile": {
"type": "boolean"
},
"turnstileSiteKey": {
"type": "string",
"nullable": true
},
"turnstileSecretKey": {
"type": "string",
"nullable": true
},
"sensitiveMediaDetection": {
"type": "string",
"enum": [
"none",
"all",
"local",
"remote"
]
},
"sensitiveMediaDetectionSensitivity": {
"type": "string",
"enum": [
"medium",
"low",
"high",
"veryLow",
"veryHigh"
]
},
"setSensitiveFlagAutomatically": {
"type": "boolean"
},
"enableSensitiveMediaDetectionForVideos": {
"type": "boolean"
},
"proxyAccountId": {
"type": "string",
"format": "misskey:id",
"nullable": true
},
"maintainerName": {
"type": "string",
"nullable": true
},
"maintainerEmail": {
"type": "string",
"nullable": true
},
"langs": {
"type": "array",
"items": {
"type": "string"
}
},
"summalyProxy": {
"type": "string",
"nullable": true
},
"deeplAuthKey": {
"type": "string",
"nullable": true
},
"deeplIsPro": {
"type": "boolean"
},
"enableEmail": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"smtpSecure": {
"type": "boolean"
},
"smtpHost": {
"type": "string",
"nullable": true
},
"smtpPort": {
"type": "integer",
"nullable": true
},
"smtpUser": {
"type": "string",
"nullable": true
},
"smtpPass": {
"type": "string",
"nullable": true
},
"enableServiceWorker": {
"type": "boolean"
},
"swPublicKey": {
"type": "string",
"nullable": true
},
"swPrivateKey": {
"type": "string",
"nullable": true
},
"tosUrl": {
"type": "string",
"nullable": true
},
"repositoryUrl": {
"type": "string"
},
"feedbackUrl": {
"type": "string"
},
"useObjectStorage": {
"type": "boolean"
},
"objectStorageBaseUrl": {
"type": "string",
"nullable": true
},
"objectStorageBucket": {
"type": "string",
"nullable": true
},
"objectStoragePrefix": {
"type": "string",
"nullable": true
},
"objectStorageEndpoint": {
"type": "string",
"nullable": true
},
"objectStorageRegion": {
"type": "string",
"nullable": true
},
"objectStoragePort": {
"type": "integer",
"nullable": true
},
"objectStorageAccessKey": {
"type": "string",
"nullable": true
},
"objectStorageSecretKey": {
"type": "string",
"nullable": true
},
"objectStorageUseSSL": {
"type": "boolean"
},
"objectStorageUseProxy": {
"type": "boolean"
},
"objectStorageSetPublicRead": {
"type": "boolean"
},
"objectStorageS3ForcePathStyle": {
"type": "boolean"
},
"enableIpLogging": {
"type": "boolean"
},
"enableActiveEmailValidation": {
"type": "boolean"
},
"enableChartsForRemoteUser": {
"type": "boolean"
},
"enableChartsForFederatedInstances": {
"type": "boolean"
},
"enableServerMachineStats": {
"type": "boolean"
},
"enableIdenticonGeneration": {
"type": "boolean"
},
"serverRules": {
"type": "array",
"items": {
"type": "string"
}
},
"preservedUsernames": {
"type": "array",
"items": {
"type": "string"
}
},
"manifestJsonOverride": {
"type": "string"
}
},
"required": []
}
}
}
},
"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"
}
}
}
}
}
}
}
}
}
},
"title": "admin/update-meta",
"_id": "content:api-docs:endpoints:admin:update-meta.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/admin/update-meta.json",
"_extension": "json"
}