nodes/generated

Interface GrafanaNodeParameters

Source


interface GrafanaNodeParameters {
    additionalFields?:
        | { folderId?: string }
        | { email?: string };
    dashboardUidOrUrl?: string;
    filters?: { query?: string } | { name?: string };
    limit?: number;
    memberId?: string;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "add"
        | "remove"
        | "delete";
    resource?: "user"
    | "team"
    | "dashboard"
    | "teamMember";
    returnAll?: boolean;
    teamId?: string;
    title?: string;
    updateFields?:
        | { folderId?: string; title?: string }
        | { email?: string; name?: string }
        | { role?: "Admin" | "Editor" | "Viewer" };
    userId?: string;
}

Properties§

§readonly additionalFields?: { folderId?: string } | { email?: string }

Default: {}

§readonly dashboardUidOrUrl?: string

Unique alphabetic identifier or URL of the dashboard to delete

§readonly filters?: { query?: string } | { name?: string }

Default: {}

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}

§readonly memberId?: string

User to remove from the team. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getUsers"}

§readonly name?: string

Name of the team to create

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"

Default: "create"

§readonly resource?: "user" | "team" | "dashboard" | "teamMember"

Default: "dashboard"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly teamId?: string

ID of the team to delete

§readonly title?: string

Title of the dashboard to create

§readonly updateFields?:
    | { folderId?: string; title?: string }
    | { email?: string; name?: string }
    | { role?: "Admin" | "Editor" | "Viewer" }

Default: {}

§readonly userId?: string

User to add to a team. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getUsers"}