---
title: "GET /apis/config.karmada.io/v1alpha1/resourceinterpreterwebhookconfigurations/{name}"
method: GET
path: "/apis/config.karmada.io/v1alpha1/resourceinterpreterwebhookconfigurations/{name}"
tags: ["configKarmadaIo_v1alpha1"]
---

# GET /apis/config.karmada.io/v1alpha1/resourceinterpreterwebhookconfigurations/{name}

`GET /apis/config.karmada.io/v1alpha1/resourceinterpreterwebhookconfigurations/{name}`

## Request

- The document declares no server URL.
- Auth: none declared

read the specified ResourceInterpreterWebhookConfiguration

## Response `200`

OK

- ComGithubKarmadaIoKarmadaPkgApisConfigV1alpha1ResourceInterpreterWebhookConfiguration: ResourceInterpreterWebhookConfiguration describes the configuration of webhooks which take the responsibility to tell karmada the details of the resource object, especially for custom resources.
  - `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` IoK8sApimachineryPkgApisMetaV1ObjectMeta: ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
    - `annotations` object: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
    - `creationTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
    - `deletionGracePeriodSeconds` integer: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
    - `deletionTimestamp` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
    - `finalizers` string[]: Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
    - `generateName` string: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
    - `generation` integer: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
    - `labels` object: Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
    - `managedFields` IoK8sApimachineryPkgApisMetaV1ManagedFieldsEntry[]: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
      - `apiVersion` string: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
      - `fieldsType` string: FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
      - `fieldsV1` IoK8sApimachineryPkgApisMetaV1FieldsV1: FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff
      - `manager` string: Manager is an identifier of the workflow managing these fields.
      - `operation` string: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
      - `subresource` string: Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
      - `time` string, date-time: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
    - `name` string: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
    - `namespace` string: Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
    - `ownerReferences` IoK8sApimachineryPkgApisMetaV1OwnerReference[]: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
      - `apiVersion` string, required: API version of the referent.
      - `blockOwnerDeletion` boolean: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
      - `controller` boolean: If true, this reference points to the managing controller.
      - `kind` string, required: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
      - `name` string, required: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
      - `uid` string, required: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    - `resourceVersion` string: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
    - `selfLink` string: Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
    - `uid` string: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
  - `webhooks` ComGithubKarmadaIoKarmadaPkgApisConfigV1alpha1ResourceInterpreterWebhook[], required: Webhooks is a list of webhooks and the affected resources and operations.
    - `clientConfig` IoK8sApiAdmissionregistrationV1WebhookClientConfig, required: WebhookClientConfig contains the information to make a TLS connection with the webhook
      - `caBundle` string, byte: caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
      - `service` IoK8sApiAdmissionregistrationV1ServiceReference: ServiceReference holds a reference to Service.legacy.k8s.io
        - `name` string, required: name is the name of the service. Required
        - `namespace` string, required: namespace is the namespace of the service. Required
        - `path` string: path is an optional URL path which will be sent in any request to this service.
        - `port` integer: port is the port on the service that hosts the webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
      - `url` string: url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
    - `interpreterContextVersions` string[], required: InterpreterContextVersions is an ordered list of preferred `ResourceInterpreterContext` versions the Webhook expects. Karmada will try to use first version in the list which it supports. If none of the versions specified in this list supported by Karmada, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the Karmada, calls to the webhook will fail and be subject to the failure policy.
    - `name` string, required: Name is the full-qualified name of the webhook.
    - `rules` ComGithubKarmadaIoKarmadaPkgApisConfigV1alpha1RuleWithOperations[]: Rules describes what operations on what resources the webhook cares about. The webhook cares about an operation if it matches any Rule.
      - `apiGroups` string[], required: APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. For example: ["apps", "batch", "example.io"] means matches 3 groups. ["*"] means matches all group Note: The group could be empty, e.g the 'core' group of kubernetes, in that case use [""].
      - `apiVersions` string[], required: APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. For example: ["v1alpha1", "v1beta1"] means matches 2 versions. ["*"] means matches all versions.
      - `kinds` string[], required: Kinds is a list of resources this rule applies to. If '*' is present, the length of the slice must be one. For example: ["Deployment", "Pod"] means matches Deployment and Pod. ["*"] means apply to all resources.
      - `operations` string[], required: Operations is the operations the hook cares about. If '*' is present, the length of the slice must be one.
    - `timeoutSeconds` integer: TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.

---

[API](https://skmtc.dev/karmada-io/apis/karmada-openapi.md) - [All operations](https://skmtc.dev/karmada-io/apis/karmada-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/karmada-io/apis/karmada-openapi/revisions/9333136fd017?raw)