--- title: "List data importers" method: GET path: "/data-importers" tags: ["Data Importer"] --- # List data importers `GET /data-importers` This API lists all data importers in the kubernetes cluster. ## Query parameters - `supportedEngines` string[] ## Response `200` Successful operation - DataImporterList — DataImporterList is an object that contains the list of the existing data importers. - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `items` DataImporter[] - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `metadata` object - `spec` object — DataImporterSpec defines the specification of a DataImporter. - `clusterPermissions` object[] — ClusterPermissions defines the cluster-wide permissions required by the data importer. These permissions are used to generate a ClusterRole for the data importer job. - `apiGroups` string[] — APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups. - `nonResourceURLs` string[] — NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. - `resourceNames` string[] — ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. - `resources` string[] — Resources is a list of resources this rule applies to. '*' represents all resources. - `verbs` string[], required — Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs. - `config` object — Config contains additional configuration defined for the data importer. - `openAPIV3Schema` unknown - `databaseClusterConstraints` object — DatabaseClusterConstraints defines compatibility requirements and prerequisites that must be satisfied by a DatabaseCluster before this data importer can be used with it. This allows the data importer to express specific requirements about the database configuration needed for successful import operations, such as required database fields, specific engine configurations, or other database properties. When a DatabaseCluster references this data importer, the operator will validate the DatabaseCluster against these constraints before proceeding with the import operation. - `requiredFields` string[] — RequiredFields contains a list of fields that must be set in the DatabaseCluster spec. Each key is a JSON path expressions that points to a field in the DatabaseCluster spec. For example, ".spec.engine.type" or ".spec.dataSource.dataImport.config.someField". - `description` string — Description is the description of the data importer. - `displayName` string — DisplayName is a human-readable name for the data importer. - `jobSpec` object — JobSpec is the specification of the data importer job. - `command` string[] — Command is the command to run the data importer. - `image` string — Image is the image of the data importer. - `permissions` object[] — Permissions defines the permissions required by the data importer. These permissions are used to generate a Role for the data importer job. - `apiGroups` string[] — APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups. - `nonResourceURLs` string[] — NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. - `resourceNames` string[] — ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. - `resources` string[] — Resources is a list of resources this rule applies to. '*' represents all resources. - `verbs` string[], required — Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs. - `supportedEngines` string[] — SupportedEngines is the list of engines that the data importer supports. - `status` object - `metadata` object ## Other responses - `400` — Unsuccessful operation - `500` — Internal server error --- [API](https://skmtc.net/openeverest/apis/openeverest-schema.md) · [All operations](https://skmtc.net/openeverest/apis/openeverest-schema/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openeverest/openeverest-schema/versions/46b19e13670b/schema)