POSTAPIの概要 実装を見る
No description provided.
Credential required: Yes
200 レスポンス リクエスト成功(内容あり)
名前 | 型 | 例 |
---|
cacheRemoteFiles | 真偽値 | - |
cacheRemoteSensitiveFiles | 真偽値 | - |
emailRequiredForSignup | 真偽値 | - |
enableHcaptcha | 真偽値 | - |
hcaptchaSiteKey | 文字列 | - |
enableRecaptcha | 真偽値 | - |
recaptchaSiteKey | 文字列 | - |
enableTurnstile | 真偽値 | - |
turnstileSiteKey | 文字列 | - |
swPublickey | 文字列 | - |
mascotImageUrl | 文字列 | - |
bannerUrl | 文字列 | - |
serverErrorImageUrl | 文字列 | - |
infoImageUrl | 文字列 | - |
notFoundImageUrl | 文字列 | - |
iconUrl | 文字列 | - |
app192IconUrl | 文字列 | - |
app512IconUrl | 文字列 | - |
enableEmail | 真偽値 | - |
enableServiceWorker | 真偽値 | - |
translatorAvailable | 真偽値 | - |
userStarForReactionFallback | 真偽値 | - |
pinnedUsers | 配列(内容: 文字列) | - |
hiddenTags | 配列(内容: 文字列) | - |
blockedHosts | 配列(内容: 文字列) | - |
sensitiveWords | 配列(内容: 文字列) | - |
preservedUsernames | 配列(内容: 文字列) | - |
hcaptchaSecretKey | 文字列 | - |
recaptchaSecretKey | 文字列 | - |
turnstileSecretKey | 文字列 | - |
sensitiveMediaDetection | 文字列 | - |
sensitiveMediaDetectionSensitivity | 文字列 | - |
setSensitiveFlagAutomatically | 真偽値 | - |
enableSensitiveMediaDetectionForVideos | 真偽値 | - |
proxyAccountId | 文字列 | - |
summaryProxy | 文字列 | - |
email | 文字列 | - |
smtpSecure | 真偽値 | - |
smtpHost | 文字列 | - |
smtpPort | 数字 | - |
smtpUser | 文字列 | - |
smtpPass | 文字列 | - |
swPrivateKey | 文字列 | - |
useObjectStorage | 真偽値 | - |
objectStorageBaseUrl | 文字列 | - |
objectStorageBucket | 文字列 | - |
objectStoragePrefix | 文字列 | - |
objectStorageEndpoint | 文字列 | - |
objectStorageRegion | 文字列 | - |
objectStoragePort | 数字 | - |
objectStorageAccessKey | 文字列 | - |
objectStorageSecretKey | 文字列 | - |
objectStorageUseSSL | 真偽値 | - |
objectStorageUseProxy | 真偽値 | - |
objectStorageSetPublicRead | 真偽値 | - |
enableIpLogging | 真偽値 | - |
enableActiveEmailValidation | 真偽値 | - |
enableChartsForRemoteUser | 真偽値 | - |
enableChartsForFederatedInstances | 真偽値 | - |
enableServerMachineStats | 真偽値 | - |
enableIdenticonGeneration | 真偽値 | - |
manifestJsonOverride | 文字列 | - |
policies | オブジェクト | - |
400 エラー クライアント側エラー
401 エラー 認証エラー
403 エラー 権限関連のエラー
418 エラー I'm Ai
500 エラー サーバー内部エラー
{
"_path": "/api-docs/endpoints/admin/meta",
"_dir": "admin",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "admin/meta",
"summary": "admin/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/meta.ts"
},
"tags": [
"meta"
],
"security": [
{
"ApiKeyAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK (with results)",
"content": {
"application/json": {
"schema": {
"type": "object",
"optional": false,
"nullable": false,
"properties": {
"cacheRemoteFiles": {
"type": "boolean",
"optional": false,
"nullable": false
},
"cacheRemoteSensitiveFiles": {
"type": "boolean",
"optional": false,
"nullable": false
},
"emailRequiredForSignup": {
"type": "boolean",
"optional": false,
"nullable": false
},
"enableHcaptcha": {
"type": "boolean",
"optional": false,
"nullable": false
},
"hcaptchaSiteKey": {
"type": "string",
"optional": false,
"nullable": true
},
"enableRecaptcha": {
"type": "boolean",
"optional": false,
"nullable": false
},
"recaptchaSiteKey": {
"type": "string",
"optional": false,
"nullable": true
},
"enableTurnstile": {
"type": "boolean",
"optional": false,
"nullable": false
},
"turnstileSiteKey": {
"type": "string",
"optional": false,
"nullable": true
},
"swPublickey": {
"type": "string",
"optional": false,
"nullable": true
},
"mascotImageUrl": {
"type": "string",
"optional": false,
"nullable": true,
"default": "/assets/ai.png"
},
"bannerUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"serverErrorImageUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"infoImageUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"notFoundImageUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"iconUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"app192IconUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"app512IconUrl": {
"type": "string",
"optional": false,
"nullable": true
},
"enableEmail": {
"type": "boolean",
"optional": false,
"nullable": false
},
"enableServiceWorker": {
"type": "boolean",
"optional": false,
"nullable": false
},
"translatorAvailable": {
"type": "boolean",
"optional": false,
"nullable": false
},
"userStarForReactionFallback": {
"type": "boolean",
"optional": true,
"nullable": false
},
"pinnedUsers": {
"type": "array",
"optional": true,
"nullable": false,
"items": {
"type": "string",
"optional": false,
"nullable": false
}
},
"hiddenTags": {
"type": "array",
"optional": true,
"nullable": false,
"items": {
"type": "string",
"optional": false,
"nullable": false
}
},
"blockedHosts": {
"type": "array",
"optional": true,
"nullable": false,
"items": {
"type": "string",
"optional": false,
"nullable": false
}
},
"sensitiveWords": {
"type": "array",
"optional": true,
"nullable": false,
"items": {
"type": "string",
"optional": false,
"nullable": false
}
},
"preservedUsernames": {
"type": "array",
"optional": false,
"nullable": false,
"items": {
"type": "string",
"optional": false,
"nullable": false
}
},
"hcaptchaSecretKey": {
"type": "string",
"optional": true,
"nullable": true
},
"recaptchaSecretKey": {
"type": "string",
"optional": true,
"nullable": true
},
"turnstileSecretKey": {
"type": "string",
"optional": true,
"nullable": true
},
"sensitiveMediaDetection": {
"type": "string",
"optional": true,
"nullable": false
},
"sensitiveMediaDetectionSensitivity": {
"type": "string",
"optional": true,
"nullable": false
},
"setSensitiveFlagAutomatically": {
"type": "boolean",
"optional": true,
"nullable": false
},
"enableSensitiveMediaDetectionForVideos": {
"type": "boolean",
"optional": true,
"nullable": false
},
"proxyAccountId": {
"type": "string",
"optional": true,
"nullable": true,
"format": "id"
},
"summaryProxy": {
"type": "string",
"optional": true,
"nullable": true
},
"email": {
"type": "string",
"optional": true,
"nullable": true
},
"smtpSecure": {
"type": "boolean",
"optional": true,
"nullable": false
},
"smtpHost": {
"type": "string",
"optional": true,
"nullable": true
},
"smtpPort": {
"type": "number",
"optional": true,
"nullable": true
},
"smtpUser": {
"type": "string",
"optional": true,
"nullable": true
},
"smtpPass": {
"type": "string",
"optional": true,
"nullable": true
},
"swPrivateKey": {
"type": "string",
"optional": true,
"nullable": true
},
"useObjectStorage": {
"type": "boolean",
"optional": true,
"nullable": false
},
"objectStorageBaseUrl": {
"type": "string",
"optional": true,
"nullable": true
},
"objectStorageBucket": {
"type": "string",
"optional": true,
"nullable": true
},
"objectStoragePrefix": {
"type": "string",
"optional": true,
"nullable": true
},
"objectStorageEndpoint": {
"type": "string",
"optional": true,
"nullable": true
},
"objectStorageRegion": {
"type": "string",
"optional": true,
"nullable": true
},
"objectStoragePort": {
"type": "number",
"optional": true,
"nullable": true
},
"objectStorageAccessKey": {
"type": "string",
"optional": true,
"nullable": true
},
"objectStorageSecretKey": {
"type": "string",
"optional": true,
"nullable": true
},
"objectStorageUseSSL": {
"type": "boolean",
"optional": true,
"nullable": false
},
"objectStorageUseProxy": {
"type": "boolean",
"optional": true,
"nullable": false
},
"objectStorageSetPublicRead": {
"type": "boolean",
"optional": true,
"nullable": false
},
"enableIpLogging": {
"type": "boolean",
"optional": true,
"nullable": false
},
"enableActiveEmailValidation": {
"type": "boolean",
"optional": true,
"nullable": false
},
"enableChartsForRemoteUser": {
"type": "boolean",
"optional": false,
"nullable": false
},
"enableChartsForFederatedInstances": {
"type": "boolean",
"optional": false,
"nullable": false
},
"enableServerMachineStats": {
"type": "boolean",
"optional": false,
"nullable": false
},
"enableIdenticonGeneration": {
"type": "boolean",
"optional": false,
"nullable": false
},
"manifestJsonOverride": {
"type": "string",
"optional": true,
"nullable": false
},
"policies": {
"type": "object",
"optional": false,
"nullable": false
}
},
"required": [
"cacheRemoteFiles",
"cacheRemoteSensitiveFiles",
"emailRequiredForSignup",
"enableHcaptcha",
"hcaptchaSiteKey",
"enableRecaptcha",
"recaptchaSiteKey",
"enableTurnstile",
"turnstileSiteKey",
"swPublickey",
"mascotImageUrl",
"bannerUrl",
"serverErrorImageUrl",
"infoImageUrl",
"notFoundImageUrl",
"iconUrl",
"app192IconUrl",
"app512IconUrl",
"enableEmail",
"enableServiceWorker",
"translatorAvailable",
"preservedUsernames",
"enableChartsForRemoteUser",
"enableChartsForFederatedInstances",
"enableServerMachineStats",
"enableIdenticonGeneration",
"policies"
]
}
}
}
},
"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/meta",
"_id": "content:api-docs:endpoints:admin:meta.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/admin/meta.json",
"_extension": "json"
}