{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/looker/json-schema/looker-instance-schema.json",
  "title": "Instance",
  "description": "A Looker instance.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/looker-projects-api-openapi.yml#/components/schemas/Instance",
  "type": "object",
  "properties": {
    "state": {
      "readOnly": true,
      "type": "string",
      "enum": [
        "STATE_UNSPECIFIED",
        "ACTIVE",
        "CREATING",
        "FAILED",
        "SUSPENDED",
        "UPDATING",
        "DELETING",
        "EXPORTING",
        "IMPORTING"
      ],
      "description": "Output only. The state of the instance."
    },
    "linkedLspProjectNumber": {
      "type": "string",
      "format": "int64",
      "description": "Optional. Linked Google Cloud Project Number for Looker Studio Pro."
    },
    "catalogIntegrationOptOut": {
      "description": "Optional. Indicates whether catalog integration is disabled for the Looker instance.",
      "type": "boolean"
    },
    "platformEdition": {
      "description": "Optional. Platform edition. Marked as OPTIONAL for backward compatibility, though it is required during instance creation.",
      "enum": [
        "PLATFORM_EDITION_UNSPECIFIED",
        "LOOKER_CORE_TRIAL",
        "LOOKER_CORE_STANDARD",
        "LOOKER_CORE_STANDARD_ANNUAL",
        "LOOKER_CORE_ENTERPRISE_ANNUAL",
        "LOOKER_CORE_EMBED_ANNUAL",
        "LOOKER_CORE_NONPROD_STANDARD_ANNUAL",
        "LOOKER_CORE_NONPROD_ENTERPRISE_ANNUAL",
        "LOOKER_CORE_NONPROD_EMBED_ANNUAL",
        "LOOKER_CORE_TRIAL_STANDARD",
        "LOOKER_CORE_TRIAL_ENTERPRISE",
        "LOOKER_CORE_TRIAL_EMBED"
      ],
      "type": "string"
    },
    "encryptionConfig": {
      "$ref": "#/$defs/EncryptionConfig",
      "description": "Optional. Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance."
    },
    "userMetadata": {
      "$ref": "#/$defs/UserMetadata",
      "description": "Optional. User metadata."
    },
    "geminiEnabled": {
      "description": "Optional. Whether Gemini feature is enabled on the Looker instance or not.",
      "type": "boolean"
    },
    "egressPublicIp": {
      "description": "Output only. Public Egress IP (IPv4).",
      "readOnly": true,
      "type": "string"
    },
    "satisfiesPzi": {
      "description": "Output only. Reserved for future use.",
      "readOnly": true,
      "type": "boolean"
    },
    "satisfiesPzs": {
      "description": "Output only. Reserved for future use.",
      "readOnly": true,
      "type": "boolean"
    },
    "periodicExportConfig": {
      "$ref": "#/$defs/PeriodicExportConfig",
      "description": "Optional. Configuration for periodic export."
    },
    "pscEnabled": {
      "description": "Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither `public_ip_enabled` nor `private_ip_enabled` can be true.",
      "type": "boolean"
    },
    "ingressPublicIp": {
      "readOnly": true,
      "type": "string",
      "description": "Output only. Public Ingress IP (IPv4)."
    },
    "privateIpEnabled": {
      "type": "boolean",
      "description": "Optional. Whether private IP is enabled on the Looker instance."
    },
    "classType": {
      "enum": [
        "CLASS_TYPE_UNSPECIFIED",
        "R1",
        "P1"
      ],
      "description": "Optional. Storage class of the instance.",
      "type": "string"
    },
    "createTime": {
      "format": "google-datetime",
      "type": "string",
      "description": "Output only. The time when the Looker instance provisioning was first requested.",
      "readOnly": true
    },
    "lookerUri": {
      "type": "string",
      "readOnly": true,
      "description": "Output only. Looker instance URI which can be used to access the Looker Instance UI."
    },
    "updateTime": {
      "type": "string",
      "readOnly": true,
      "description": "Output only. The time when the Looker instance was last updated.",
      "format": "google-datetime"
    },
    "name": {
      "description": "Output only. Format: `projects/{project}/locations/{location}/instances/{instance}`.",
      "readOnly": true,
      "type": "string"
    },
    "acceleratedSecurityPatchEnabled": {
      "type": "boolean",
      "description": "Optional. Accelerated security patch enabled for the instance."
    },
    "lookerVersion": {
      "description": "Output only. The Looker version that the instance is using.",
      "readOnly": true,
      "type": "string"
    },
    "adminSettings": {
      "$ref": "#/$defs/AdminSettings",
      "description": "Optional. Looker Instance Admin settings."
    },
    "reservedRange": {
      "type": "string",
      "description": "Optional. Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request."
    },
    "maintenanceWindow": {
      "$ref": "#/$defs/MaintenanceWindow",
      "description": "Optional. Maintenance window for this instance."
    },
    "consumerNetwork": {
      "description": "Optional. Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.",
      "type": "string"
    },
    "ingressIpAllowlistConfig": {
      "$ref": "#/$defs/IngressIpAllowlistConfig",
      "description": "Optional. Ingress IP allowlist configuration for the Looker instance."
    },
    "releaseChannel": {
      "type": "string",
      "description": "Optional. The selected release channel for the instance.",
      "enum": [
        "RELEASE_CHANNEL_UNSPECIFIED",
        "RAPID",
        "REGULAR",
        "STABLE"
      ]
    },
    "publicIpEnabled": {
      "description": "Optional. Whether public IP is enabled on the Looker instance.",
      "type": "boolean"
    },
    "authType": {
      "$ref": "#/$defs/AuthType",
      "description": "Optional. Auth type for the Looker instance."
    },
    "lastDenyMaintenancePeriod": {
      "$ref": "#/$defs/DenyMaintenancePeriod",
      "description": "Output only. Last computed maintenance denial period for this instance."
    },
    "maintenanceSchedule": {
      "$ref": "#/$defs/MaintenanceSchedule",
      "description": "Output only. Maintenance schedule for this instance."
    },
    "customDomain": {
      "$ref": "#/$defs/CustomDomain",
      "description": "Optional. Custom domain configuration for the instance."
    },
    "controlledEgressEnabled": {
      "description": "Optional. Whether controlled egress is enabled on the Looker instance.",
      "type": "boolean"
    },
    "pscConfig": {
      "$ref": "#/$defs/PscConfig",
      "description": "Optional. PSC configuration. Used when `psc_enabled` is true."
    },
    "fipsEnabled": {
      "description": "Optional. Whether FIPS is enabled on the Looker instance.",
      "type": "boolean"
    },
    "denyMaintenancePeriod": {
      "$ref": "#/$defs/DenyMaintenancePeriod",
      "description": "Optional. Maintenance denial period for this instance."
    },
    "suspendedTime": {
      "format": "google-datetime",
      "readOnly": true,
      "description": "Output only. The time when the Looker instance was suspended (soft deleted).",
      "type": "string"
    },
    "controlledEgressConfig": {
      "$ref": "#/$defs/ControlledEgressConfig",
      "description": "Optional. Controlled egress configuration."
    },
    "oauthConfig": {
      "$ref": "#/$defs/OAuthConfig",
      "description": "Optional. Looker instance OAuth login settings."
    },
    "softDeleteReason": {
      "enum": [
        "SOFT_DELETE_REASON_UNSPECIFIED",
        "BILLING_ACCOUNT_ISSUE",
        "TRIAL_EXPIRED",
        "CUSTOMER_REQUEST"
      ],
      "type": "string",
      "readOnly": true,
      "description": "Output only. The reason for the instance being in a soft-deleted state."
    },
    "ingressPrivateIp": {
      "readOnly": true,
      "type": "string",
      "description": "Output only. Private Ingress IP (IPv4)."
    }
  },
  "$defs": {
    "AdminSettings": {
      "type": "object",
      "description": "Looker instance Admin settings fields.",
      "properties": {
        "allowedEmailDomains": {
          "type": "array",
          "description": "Optional. Email domain allowlist for the instance.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "AuthType": {
      "properties": {
        "googleAuthEnabled": {
          "type": "boolean",
          "description": "Optional. Whether google auth is enabled on the Looker instance."
        },
        "workforceAuthEnabled": {
          "type": "boolean",
          "description": "Optional. Whether Workforce auth is enabled on the Looker instance."
        }
      },
      "type": "object",
      "description": "Auth type for the Looker instance."
    },
    "ControlledEgressConfig": {
      "description": "Controlled egress configuration.",
      "properties": {
        "egressFqdns": {
          "description": "Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "webProxyIps": {
          "readOnly": true,
          "description": "Output only. The list of IP addresses used by Secure Web Proxy for outbound traffic.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "marketplaceEnabled": {
          "description": "Optional. Whether marketplace is enabled.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "CustomDomain": {
      "type": "object",
      "description": "Custom domain information.",
      "properties": {
        "state": {
          "description": "Output only. Domain state.",
          "enum": [
            "CUSTOM_DOMAIN_STATE_UNSPECIFIED",
            "UNVERIFIED",
            "VERIFIED",
            "MODIFYING",
            "AVAILABLE",
            "UNAVAILABLE",
            "UNKNOWN"
          ],
          "readOnly": true,
          "type": "string"
        },
        "domain": {
          "description": "Optional. Domain name.",
          "type": "string"
        }
      }
    },
    "Date": {
      "type": "object",
      "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
      "properties": {
        "day": {
          "type": "integer",
          "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
          "format": "int32"
        },
        "month": {
          "format": "int32",
          "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
          "type": "integer"
        },
        "year": {
          "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "DenyMaintenancePeriod": {
      "type": "object",
      "description": "Specifies the maintenance denial period.",
      "properties": {
        "endDate": {
          "$ref": "#/$defs/Date",
          "description": "Required. End date of the deny maintenance period."
        },
        "startDate": {
          "$ref": "#/$defs/Date",
          "description": "Required. Start date of the deny maintenance period."
        },
        "time": {
          "$ref": "#/$defs/TimeOfDay",
          "description": "Required. Time in UTC when the period starts and ends."
        }
      }
    },
    "EncryptionConfig": {
      "properties": {
        "kmsKeyState": {
          "description": "Output only. Status of the CMEK key.",
          "type": "string",
          "enum": [
            "KMS_KEY_STATE_UNSPECIFIED",
            "VALID",
            "REVOKED"
          ],
          "readOnly": true
        },
        "kmsKeyName": {
          "type": "string",
          "description": "Optional. Immutable. Name of the CMEK key in KMS (input parameter)."
        },
        "kmsKeyNameVersion": {
          "description": "Output only. Full name and version of the CMEK key currently in use to encrypt Looker data. Format: `projects/{project}/locations/{location}/keyRings/{ring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`. Empty if CMEK is not configured in this instance.",
          "type": "string",
          "readOnly": true
        }
      },
      "type": "object",
      "description": "Encryption configuration (i.e. CMEK)."
    },
    "IngressIpAllowlistConfig": {
      "properties": {
        "enabled": {
          "description": "Optional. Whether ingress IP allowlist functionality is enabled on the Looker instance.",
          "type": "boolean"
        },
        "googleServicesEnabled": {
          "type": "boolean",
          "description": "Optional. Whether google service connections are enabled for the instance."
        },
        "allowlistRules": {
          "type": "array",
          "description": "Optional. List of IP range rules to allow ingress traffic.",
          "items": {
            "$ref": "#/$defs/IngressIpAllowlistRule"
          }
        }
      },
      "description": "Ingress IP allowlist configuration.",
      "type": "object"
    },
    "IngressIpAllowlistRule": {
      "properties": {
        "description": {
          "type": "string",
          "description": "Optional. Description for the IP range."
        },
        "ipRange": {
          "type": "string",
          "description": "Optional. The IP range to allow ingress traffic from."
        }
      },
      "type": "object",
      "description": "Ingress IP allowlist rule."
    },
    "MaintenanceSchedule": {
      "type": "object",
      "properties": {
        "startTime": {
          "type": "string",
          "format": "google-datetime",
          "description": "The scheduled start time for the maintenance."
        },
        "endTime": {
          "description": "The scheduled end time for the maintenance.",
          "format": "google-datetime",
          "type": "string"
        }
      },
      "description": "Published upcoming future maintenance schedule."
    },
    "MaintenanceWindow": {
      "type": "object",
      "properties": {
        "dayOfWeek": {
          "description": "Required. Day of the week for this MaintenanceWindow (in UTC).",
          "type": "string",
          "enum": [
            "DAY_OF_WEEK_UNSPECIFIED",
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY",
            "SATURDAY",
            "SUNDAY"
          ]
        },
        "startTime": {
          "$ref": "#/$defs/TimeOfDay",
          "description": "Required. Time in UTC when the period starts. Maintenance will be scheduled within 60 minutes."
        }
      },
      "description": "Specifies the recurring maintenance window."
    },
    "OAuthConfig": {
      "description": "Looker instance OAuth login settings.",
      "type": "object",
      "properties": {
        "clientSecret": {
          "description": "Input only. Client secret from an external OAuth application. This is an input-only field, and thus will not be set in any responses.",
          "type": "string"
        },
        "sharedOauthClientEnabled": {
          "description": "Optional. Whether to use the shared OAuth client. Instances specifying this field do not need to provide client_id and client_secret.",
          "type": "boolean"
        },
        "clientId": {
          "description": "Input only. Client ID from an external OAuth application. This is an input-only field, and thus will not be set in any responses.",
          "type": "string"
        }
      }
    },
    "PeriodicExportConfig": {
      "description": "Configuration for periodic export.",
      "type": "object",
      "properties": {
        "gcsUri": {
          "description": "Required. Cloud Storage bucket URI for periodic export. Format: gs://{bucket_name}",
          "type": "string"
        },
        "kmsKey": {
          "description": "Required. Name of the CMEK key in KMS. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}",
          "type": "string"
        },
        "startTime": {
          "$ref": "#/$defs/TimeOfDay",
          "description": "Required. Time in UTC to start the periodic export job."
        }
      }
    },
    "PscConfig": {
      "properties": {
        "serviceAttachments": {
          "description": "Optional. List of egress service attachment configurations.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/ServiceAttachment"
          }
        },
        "allowedVpcs": {
          "items": {
            "type": "string"
          },
          "description": "Optional. List of VPCs that are allowed ingress into looker. Format: projects/{project}/global/networks/{network}",
          "type": "array"
        },
        "lookerServiceAttachmentUri": {
          "type": "string",
          "readOnly": true,
          "description": "Output only. URI of the Looker service attachment."
        }
      },
      "type": "object",
      "description": "Information for Private Service Connect (PSC) setup for a Looker instance."
    },
    "ServiceAttachment": {
      "properties": {
        "localFqdns": {
          "items": {
            "type": "string"
          },
          "description": "Optional. List of fully qualified domain names that will be used in the private DNS record created for the service attachment.",
          "type": "array"
        },
        "targetServiceAttachmentUri": {
          "type": "string",
          "description": "Required. URI of the service attachment to connect to. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}"
        },
        "failureReason": {
          "type": "string",
          "readOnly": true,
          "description": "Output only. Reason the service attachment creation failed. This value will only be populated if the service attachment encounters an issue during provisioning."
        },
        "localFqdn": {
          "description": "Optional. Fully qualified domain name that will be used in the private DNS record created for the service attachment.",
          "type": "string"
        },
        "connectionStatus": {
          "type": "string",
          "enum": [
            "UNKNOWN",
            "ACCEPTED",
            "PENDING",
            "REJECTED",
            "NEEDS_ATTENTION",
            "CLOSED"
          ],
          "description": "Output only. Connection status.",
          "readOnly": true
        }
      },
      "description": "Service attachment configuration.",
      "type": "object"
    },
    "TimeOfDay": {
      "properties": {
        "seconds": {
          "format": "int32",
          "type": "integer",
          "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds."
        },
        "nanos": {
          "format": "int32",
          "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.",
          "type": "integer"
        },
        "minutes": {
          "type": "integer",
          "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.",
          "format": "int32"
        },
        "hours": {
          "type": "integer",
          "format": "int32",
          "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time."
        }
      },
      "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
      "type": "object"
    },
    "UserMetadata": {
      "description": "Metadata about users for a Looker instance.",
      "type": "object",
      "properties": {
        "additionalViewerUserCount": {
          "type": "integer",
          "format": "int32",
          "description": "Optional. The number of additional viewer users the instance owner has purchased."
        },
        "additionalStandardUserCount": {
          "description": "Optional. The number of additional standard users the instance owner has purchased.",
          "format": "int32",
          "type": "integer"
        },
        "additionalDeveloperUserCount": {
          "format": "int32",
          "type": "integer",
          "description": "Optional. The number of additional developer users the instance owner has purchased."
        }
      }
    }
  }
}