{
  "opencollection": "1.0.0",
  "info": {
    "name": "openobserve Actions Folders API",
    "version": "0.90.0"
  },
  "items": [
    {
      "info": {
        "name": "Folders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List organization folders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/:org_id/folders/:folder_type",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_type",
                "value": "",
                "type": "path",
                "description": "Type of data the folder can contain"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a list of all folders in the organization for the specified folder type. Users will only see folders they have access to when role-based access control is enabled."
        },
        {
          "info": {
            "name": "Create new folder",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/:org_id/folders/:folder_type",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_type",
                "value": "",
                "type": "path",
                "description": "Type of data the folder can contain"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Creates a new folder for organizing dashboards, alerts, or reports. Folders help users organize their content into logical groups and manage access permissions when using role-based access control."
        },
        {
          "info": {
            "name": "Get folder by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/:org_id/folders/:folder_type/name/:folder_name",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_type",
                "value": "",
                "type": "path",
                "description": "Type of data the folder can contain"
              },
              {
                "name": "folder_name",
                "value": "",
                "type": "path",
                "description": "Folder Name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves detailed information about a specific folder by its name rather than ID. Useful when you know the folder name but not its unique identifier. Returns folder information for the specified folder type and name."
        },
        {
          "info": {
            "name": "Get folder details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/:org_id/folders/:folder_type/:folder_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_type",
                "value": "",
                "type": "path",
                "description": "Type of data the folder can contain"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path",
                "description": "Folder ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves detailed information about a specific folder including its name, description, creation details, and metadata. Returns folder information for the specified folder type and ID."
        },
        {
          "info": {
            "name": "Update folder details",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/:org_id/folders/:folder_type/:folder_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_type",
                "value": "",
                "type": "path",
                "description": "Type of data the folder can contain"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path",
                "description": "Folder name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Updates an existing folder's name, description, or other properties. Note that the default folder cannot be updated and folders containing content may have restrictions on certain changes."
        },
        {
          "info": {
            "name": "Delete folder",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/:org_id/folders/:folder_type/:folder_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_type",
                "value": "",
                "type": "path",
                "description": "Type of data the folder can contain"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path",
                "description": "Folder ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Permanently deletes a folder and removes it from the organization. The folder must be empty (no dashboards, alerts, or reports) before it can be deleted. The default folder cannot be deleted."
        },
        {
          "info": {
            "name": "List all folders (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/folders",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves all dashboard folders for the organization - this endpoint is deprecated"
        },
        {
          "info": {
            "name": "Create a new folder (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/folders",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Creates a new dashboard folder - this endpoint is deprecated"
        },
        {
          "info": {
            "name": "Get folder by name (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/folders/name/:folder_name",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_name",
                "value": "",
                "type": "path",
                "description": "Folder Name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a folder using its name instead of ID - this endpoint is deprecated"
        },
        {
          "info": {
            "name": "Get folder by ID (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/folders/:folder_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path",
                "description": "Folder ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a specific folder by its identifier - this endpoint is deprecated"
        },
        {
          "info": {
            "name": "Update an existing folder (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/:org_id/folders/:folder_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path",
                "description": "Folder name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Updates folder details like name and description - this endpoint is deprecated"
        },
        {
          "info": {
            "name": "Delete a folder (deprecated)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/:org_id/folders/:folder_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "folder_id",
                "value": "",
                "type": "path",
                "description": "Folder ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Removes a folder and all its contents - this endpoint is deprecated"
        }
      ]
    }
  ],
  "bundled": true
}