Skip to main content

Returns a specific dns zone​

Returns a specific dns zone

Path Parameters
    workspace stringrequired

    Workspace to use

    name stringrequired

    The name of the dns zone you wish to retrieve

Responses​

Contains the dns zone definition

Schema
    apiVersion string
    kind string
    metadata

    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: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
    • clusterName string
    creationTimestamp string
    deletionGracePeriodSeconds int64
    deletionTimestamp string
    finalizers string[]
    generateName string
    generation int64
    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: http://kubernetes.io/docs/user-guide/labels

  • property name* string
    • managedFields undefined[]

    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
    fieldsType string
    fieldsV1 string
    manager string
    operation string
    subresource string
    time string
    name string
    namespace string
    ownerReferences undefined[]

    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
    blockOwnerDeletion boolean
    controller boolean
    kind string
    name string
    uid string
    resourceVersion string
    selfLink string
    uid string
    spec

    DNSZoneSpec defines the specification of a DNS zone which should be provisioned

    allocation

    Allocation defines which workspaces can create child zones from this DNS zone. Only applicable to GlobalDNSZones. This must be set for AutoProvisionChildZones to have any effect.

    type string
    workspaces string[]
    availableToApps

    AvailableToApps allows a global zone to be identified for auto-provisioning of app-specific DNS zones. This is only valid on global DNS zones and is ignored otherwise.

    stage string
    availableToClusters

    AvailableToClusters allows this zone, or automatically-created child zones of it, to be made available automatically in the targeted clusters, with ExternalDNS deployed and configured.

    Leave unspecified to not make this zone available in any clusters.

    For a GlobalDNSZone, this provide DNS in any workspace (subject to the label selectors you define and the allocation specified in the Allocation field).

    For a DNSZone, this will only provide DNS for clusters in the same workspace the zone is created in.

    mode string
    selectors

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions undefined[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    key string
    operator string
    values string[]
    matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
    • cloudAccessConfigRef

    CloudAccessConfigRef is a reference to the cloud access config that should be used to create the DNS zone. This may not be required for all DNS providers.

    name string
    namespace string
    cloudResourceName string
    domain string
    manualChildZoneCreation boolean
    network

    Network should be specified if private is true to indicate what network this private DNS zone should be provisioned with. Ignored if Private is false/unspecified.

    group string
    kind string
    name string
    namespace string
    version string
    parentZone

    ParentZone should be set to make this zone a child of another zone managed by Wayfinder. Setting this allows Wayfinder to automatically manage the delegation of this zone.

    name string
    namespace string
    private boolean
    provider string
    providerDetails

    ProviderDetails provides additional fields which can be used for DNS-provider specific data needed to provision this zone

    aws
    azure

    Azure holds parameters specific to an Azure DNS zone. Present only if type is Azure.

    resourceGroup string
    gcp
    type string
    unmanaged boolean
    status

    DNSZoneStatus defines the status of a cloud account

    cloudResourcesCreated boolean
    conditions undefined[]
    detail string
    lastTransitionTime string
    message string
    name string
    negativePolarity boolean
    observedGeneration int64
    reason string
    status string
    type string
    delegated boolean
    detail string
    lastReconcile
    generation int64
    time string
    lastSuccess
    generation int64
    time string
    message string
    nameservers string[]
    obsoleteResources undefined[]
    kind string
    name string
    providerStatus

    ProviderStatus provides any provider-specific status information about this zone.

    azure

    Azure provides information about the status of this Azure DNS zone

    resourceGroup string
    status string
    txtrecord string
    wayfinderVersion string
    zoneID string
Loading...
Last updated on 28 Dec 2023