--- title: "Returns the seed object." method: GET path: "/api/v1/admin/seeds/{seed_name}" tags: ["admin"] --- # Returns the seed object. `GET /api/v1/admin/seeds/{seed_name}` ## Request - The document declares no server URL. - Auth: API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `seed_name` string, required ## Response `200` Seed - Seed: Seed represents a seed object - `backupRestore` SeedBackupRestoreConfiguration - `s3BucketName` string: S3BucketName is the S3 bucket name to use for backup and restore. - `s3Endpoint` string: S3Endpoint is the S3 API endpoint to use for backup and restore. Defaults to s3.amazonaws.com. - `country` string: Optional: Country of the seed as ISO-3166 two-letter code, e.g. DE or UK. For informational purposes in the Kubermatic dashboard only. - `datacenters` object: Datacenters contains a map of the possible datacenters (DCs) in this seed. Each DC must have a globally unique identifier (i.e. names must be unique across all seeds). - `expose_strategy` string - `kubeconfig` ObjectReference: New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage. 2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant. 5. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object - `apiVersion` string: API version of the referent. +optional - `fieldPath` string: If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. +optional - `kind` string: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `name` string: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional - `namespace` string: Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional - `resourceVersion` string: Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `uid` string: UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. - `location` string: Optional: Detailed location of the cluster, like "Hamburg" or "Datacenter 7". For informational purposes in the Kubermatic dashboard only. - `mla` SeedMLASettings - `user_cluster_mla_enabled` boolean: Optional: UserClusterMLAEnabled controls whether the user cluster MLA (Monitoring, Logging & Alerting) stack is enabled in the seed. - `name` string: Name represents human readable name for the resource - `proxy_settings` ProxySettings: ProxySettings allow configuring a HTTP proxy for the controlplanes and nodes - `http_proxy` string - `no_proxy` string - `seed_dns_overwrite` string: Optional: This can be used to override the DNS name used for this seed. By default the seed name is used. ## Other responses - `401`: EmptyResponse is a empty response - `403`: EmptyResponse is a empty response - `default`: errorResponse --- [API](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api.md) - [All operations](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api/revisions/815b9bf19db5?raw)