{
  "opencollection": "1.0.0",
  "info": {
    "name": "ImageKit Account Management API Custom metadata fields API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Custom metadata fields",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.imagekit.io/v1/customMetadataFields",
            "params": [
              {
                "name": "includeDeleted",
                "value": "",
                "type": "query",
                "description": "Set it to `true` to include deleted field objects in the API response.\n"
              },
              {
                "name": "folderPath",
                "value": "",
                "type": "query",
                "description": "The folder path (e.g., `/path/to/folder`) for which to retrieve applicable custom metadata fields. Useful for determining path-specific field selections when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in use.\n"
              }
            ]
          },
          "docs": "This API returns the array of created custom metadata field objects. By default the API returns only non deleted field objects, but you can include deleted fields in the API response.\n\nYou can also filter results by a specific folder path to retrieve custom metadata fields applicable at that location. This path-specific filtering is useful when using the **Path policy** feature to determine which custom metadata fields are selected for a given path.\n"
        },
        {
          "info": {
            "name": "Create new field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.imagekit.io/v1/customMetadataFields",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a new custom metadata field. Once a custom metadata field is created either through this API or using the dashboard UI, its value can be set on the assets. The value of a field for an asset can be set using the media library UI or programmatically through upload or update assets API.\n"
        },
        {
          "info": {
            "name": "Update existing field",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.imagekit.io/v1/customMetadataFields/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Should be a valid custom metadata field id.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API updates the label or schema of an existing custom metadata field.\n"
        },
        {
          "info": {
            "name": "Delete a field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.imagekit.io/v1/customMetadataFields/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Should be a valid custom metadata field id.\n"
              }
            ]
          },
          "docs": "This API deletes a custom metadata field. Even after deleting a custom metadata field, you cannot create any new custom metadata field with the same name.\n"
        }
      ]
    }
  ],
  "bundled": true
}