POSTAPIの概要 実装を見る
No description provided.
Credential required: Yes / Permission: write:account
パラメータ
名前 | 型 | 既定値 |
---|
必須 | name | 文字列 | - |
必須 | src | 文字列 | - |
任意 | userListId | 文字列 | - |
必須 | keywords | 配列(内容: 配列(内容: )) | - |
必須 | excludeKeywords | 配列(内容: 配列(内容: )) | - |
必須 | users | 配列(内容: 文字列) | - |
必須 | caseSensitive | 真偽値 | - |
必須 | withReplies | 真偽値 | - |
必須 | withFile | 真偽値 | - |
必須 | notify | 真偽値 | - |
200 レスポンス リクエスト成功(内容あり)
400 エラー クライアント側エラー
401 エラー 認証エラー
403 エラー 権限関連のエラー
418 エラー I'm Ai
500 エラー サーバー内部エラー
{
"_path": "/api-docs/endpoints/antennas/create",
"_dir": "antennas",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "antennas/create",
"summary": "antennas/create",
"description": "No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:account*",
"externalDocs": {
"description": "Source code",
"url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/antennas/create.ts"
},
"tags": [
"antennas"
],
"security": [
{
"ApiKeyAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"src": {
"type": "string",
"enum": [
"home",
"all",
"users",
"list",
"users_blacklist"
]
},
"userListId": {
"type": "string",
"format": "misskey:id",
"nullable": true
},
"keywords": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"excludeKeywords": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"users": {
"type": "array",
"items": {
"type": "string"
}
},
"caseSensitive": {
"type": "boolean"
},
"withReplies": {
"type": "boolean"
},
"withFile": {
"type": "boolean"
},
"notify": {
"type": "boolean"
}
},
"required": [
"name",
"src",
"keywords",
"excludeKeywords",
"users",
"caseSensitive",
"withReplies",
"withFile",
"notify"
]
}
}
}
},
"responses": {
"200": {
"description": "OK (with results)",
"content": {
"application/json": {
"schema": {
"type": "object",
"optional": false,
"nullable": false,
"ref": "Antenna",
"$ref": "#/components/schemas/Antenna"
}
}
}
},
"400": {
"description": "Client error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"NO_SUCH_USER_LIST": {
"value": {
"error": {
"message": "No such user list.",
"code": "NO_SUCH_USER_LIST",
"id": "95063e93-a283-4b8b-9aa5-bcdb8df69a7f"
}
}
},
"TOO_MANY_ANTENNAS": {
"value": {
"error": {
"message": "You cannot create antenna any more.",
"code": "TOO_MANY_ANTENNAS",
"id": "faf47050-e8b5-438c-913c-db2b1576fde4"
}
}
},
"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": "antennas/create",
"_id": "content:api-docs:endpoints:antennas:create.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/antennas/create.json",
"_extension": "json"
}