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"
}