---
updatedAt: 2026-04-27T13:22:54.000Z
agentTools:
  projectIndex: https://developers.karte.io/llms.txt
---

# Find Craft function's metadata by name

Craft functionのメタデータをファンクション名で取得します

#### Required Scope
APIの実行に必要なScopeです。
```
beta.craft.function.metadata.findByName
```

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
Craft > Craft 設定の閲覧
```


# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "https://api.karte.io",
      "description": "Production server"
    },
    {
      "url": "https://api-jp.karte.io",
      "description": "Production JP server. リージョン固定オプションのプロジェクトはこちらのエンドポイントを利用してください."
    }
  ],
  "info": {
    "version": "2.0.0",
    "title": "Craft"
  },
  "paths": {
    "/v2beta/craft/function/metadata/findByName": {
      "post": {
        "tags": [
          "Craft Function"
        ],
        "summary": "Find Craft function's metadata by name",
        "description": "Craft functionのメタデータをファンクション名で取得します\n\n#### Required Scope\nAPIの実行に必要なScopeです。\n```\nbeta.craft.function.metadata.findByName\n```\n\n#### Required Role\n管理画面でScopeを追加する際に必要な権限です。\n```\nCraft > Craft 設定の閲覧\n```\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "name"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "ファンクション名です",
                    "example": "my-function"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientConfig"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "x-karte-api",
            "schema": {
              "type": "string"
            },
            "description": "今後利用する可能性のある予約語です。現在は設定不要です。"
          },
          {
            "in": "header",
            "name": "authorization",
            "schema": {
              "type": "string"
            },
            "description": "認証情報を含むトークンです。\"Authorization\" ヘッダーに `Bearer <token>` の形式で設定してください。"
          },
          {
            "in": "header",
            "name": "content-type",
            "schema": {
              "type": "string"
            },
            "description": "リクエストのコンテンツタイプを指定します。通常は `application/json` を使用してください。"
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "ClientConfig": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "codeVersion",
          "active",
          "created",
          "modified",
          "status"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "codeVersion": {
            "type": "string",
            "description": "現在のコードバージョン"
          },
          "active": {
            "type": "boolean",
            "description": "ファンクションの有効状態"
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "created": {
            "type": "string",
            "description": "ファンクションの作成日時"
          },
          "modified": {
            "type": "string",
            "description": "ファンクションの更新日時"
          },
          "status": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "IN_PROGRESS",
              "FAILED"
            ],
            "description": "ファンクションの最新のデプロイ結果"
          },
          "modified_by": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "account_id": {
                "type": "string"
              },
              "username": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "x-explorer-enabled": false
}
````