Skip to main content

AppEnvironment

An application environment in WordPress VIP. This type is the main operational read surface and includes commands, logs, events, backups, deployments, metrics, integrations, and security controls.

type AppEnvironment {
  active: Boolean
  activeBackup: Backup
  agentforce: Agentforce
  allowedIPs: AppEnvironmentIPAllowList
  anomalyContext(
    anomalyId: Int
  ): MetricAnomalyContext
  appId: Int
  backupPolicyId: Int
  backupShippingConfigV2: AppEnvironmentBackupShippingV2
  backups(
    after: String
    endDate: String
    first: Int
    id: Float
    startDate: String
  ): BackupsList
  backupsSqlDumpTool: String
  basicAuth: AppEnvironmentBasicAuth
  branch: String
  branches(
    limit: Int
  ): AppEnvironmentBranchesList
  buildConfiguration: BuildConfiguration
  builds: BuildList
  codebase: CodebaseInfo
  commands(
    after: String
    first: Int
    order: String
    page: Int
    sort: String
    status: String
  ): WPCLICommandList
  commits(
    first: Int
  ): GitCommitList
  createdAt: String
  currentCommit: String
  customErrorPageConfig: CustomErrorPageConfig
  datacenter: String
  dbBackupCopies(
    fileNames: [String]
  ): DBBackupCopyList
  dbOperationInProgress: Boolean
  defaultDomain: String
  defensiveMode(
    fromDate: Date
    toDate: Date
  ): AppEnvironmentDefensiveMode
  deploymentStrategy: String
  deployments(
    first: Int
    id: Int
    nextCursor: String
    page: Int
  ): DeploymentList
  deploys(
    first: Int
  ): DeployList
  domains(
    after: String
    exclude: [String]
    first: Int
    isVerified: Boolean
    matching: String
    page: Int
  ): DomainList
  edgeConfig: EdgeConfig
  edgeWorkers: [EdgeWorker!]!
  environmentVariables: EnvironmentVariablesList
  events(
    after: String
    afterTs: String
    beforeTs: String
    excludeAnomalyEvents: Boolean
    excludeEventTypePrefixes: String
    excludeWPCLI: Boolean
    first: Int
    types: String
  ): AuditEventList
  eventsCounts(
    from: String
    to: String
    types: [String]
  ): [AuditEventCount]
  getIntegrationsDevEnvConfig: IntegrationDevEnvConfig
  health(
    endDate: String
    startDate: String
  ): AppEnvironmentHealth
  hstsSettings: AppEnvironmentHSTSSettings
  icon(
    size: Int
  ): AppEnvironmentIcon
  id: Int
  importStatus: AppEnvironmentImportStatus
  insightsOverview(
    fromDate: Date!
    toDate: Date!
  ): EnvironmentInsightsOverview
  integration(
    networkSiteId: Int
    slug: String
  ): Integration
  integrations: IntegrationList
  ips: AppEnvironmentIPs
  isDBPartitioningEnabled: Boolean
  isFedramp: Boolean
  isHipaa: Boolean
  isK8sResident: Boolean
  isLiveBackupCopyAllowed: Boolean
  isMultisite: Boolean
  isOnLatestCode: Boolean
  isSubdirectoryMultisite: Boolean
  jobs(
    jobTypes: [AppEnvironmentJobType!]
    types: [String!]
  ): [JobInterface]
  latestBackup: Backup
  latestMediaExport: MediaExport
  launchModeEndAt: String
  launched: Boolean
  liveBackupCopies: [LiveBackupCopy]
  logShippingConfig: AppEnvironmentLogShippingV2
  logs(
    after: String
    limit: Int
    type: AppEnvironmentLogType
  ): AppEnvironmentLogsList
  mediaExports(
    nextCursor: String
  ): MediaExportsList
  mediaImportStatus: AppEnvironmentMediaImportStatus
  metricAnomalies(
    algorithmVersion: String
    excludeCustomAnomalies: Boolean
    fromDate: Date
    metricName: String
    toDate: Date
  ): MetricAnomaliesList
  metricThresholds(
    metricName: String
  ): [MetricThreshold]
  metrics(
    aggregate: Boolean
    fromDate: Date
    includeBaseline: Boolean
    metricName: String
    toDate: Date
  ): AggregatedMetricMeasurements
  name: String
  newRelic: AppEnvironmentNewRelic
  notificationSubscriptions(
    active: Boolean
    after: String
    first: Int
    notificationRecipientId: Int
  ): NotificationSubscriptionList
  permissions(
    permissions: [String]
  ): [PermissionResult]
  phpMyAdminStatus: PHPMyAdminStatus
  primaryDomain: Domain
  primaryDomainSwitchProgress(
    primaryDomainSwitchId: Int
  ): AppEnvironmentPrimaryDomainSwitchProgress
  repo: String
  repository: GitRepository
  requestStats(
    date: String
    days: Int
    from: String
    months: Int
    to: String
  ): RequestStatsList
  slowlogs(
    after: String
    limit: Int
  ): AppEnvironmentSlowlogsList
  software: AppEnvironmentSoftwareDetails
  softwareSettings: AppEnvironmentSoftwareSettings
  syncPreview: AppEnvironmentSyncPreview
  syncProgress(
    sync: Int
  ): AppEnvironmentSyncProgress
  type: String
  uniqueLabel: String
  updateSubsiteDomainStatus: AppEnvironmentUpdateSubsiteDomainStatus
  wpInstallation: WPInstallation
  wpSites(
    after: String
    first: Int
  ): WPSiteList
  wpSitesSDS(
    after: String
    blogId: Int
    first: Int
    launchStatus: WPSiteLaunchStatus
    matching: String
    order: String
    page: Int
    sort: String
  ): WPSiteList
  wpcliStrategy: AppEnvironmentWPCliStrategy
}

Fields​

AppEnvironment.active ● Boolean scalar common​

Whether the environment is active.

AppEnvironment.activeBackup ● Backup object common​

The currently active backup operation.

AppEnvironment.agentforce ● Agentforce object common​

Agentforce integration for syncing WordPress content to Salesforce

AppEnvironment.allowedIPs ● AppEnvironmentIPAllowList object common​

The allowlisted IP addresses for the environment.

AppEnvironment.anomalyContext ● MetricAnomalyContext object common​

Additional context for a specific anomaly.

AppEnvironment.anomalyContext.anomalyId ● Int scalar common​

The anomaly ID.

AppEnvironment.appId ● Int scalar common​

The application ID that owns the environment.

AppEnvironment.backupPolicyId ● Int scalar common​

The backup policy ID applied to the environment.

AppEnvironment.backupShippingConfigV2 ● AppEnvironmentBackupShippingV2 object common​

The current V2 backup shipping configuration.

AppEnvironment.backups ● BackupsList object common​

The backups available for the environment.

AppEnvironment.backups.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.backups.endDate ● String scalar common​

The end date for filtering backups.

AppEnvironment.backups.first ● Int scalar common​

The maximum number of backups to return.

AppEnvironment.backups.id ● Float scalar common​

The backup ID to retrieve.

AppEnvironment.backups.startDate ● String scalar common​

The start date for filtering backups.

AppEnvironment.backupsSqlDumpTool ● String scalar common​

The SQL dump tool used for backups.

AppEnvironment.basicAuth ● AppEnvironmentBasicAuth object common​

The basic auth configuration for the environment.

AppEnvironment.branch ● String scalar common​

The currently configured branch for the environment.

AppEnvironment.branches ● AppEnvironmentBranchesList object common​

Available repository branches for the environment.

AppEnvironment.branches.limit ● Int scalar common​

The maximum number of branches to return.

AppEnvironment.buildConfiguration ● BuildConfiguration object common​

The build configuration for the environment.

AppEnvironment.builds ● BuildList object common​

The build history for the environment.

AppEnvironment.codebase ● CodebaseInfo object common​

Get codebase related information

AppEnvironment.commands ● WPCLICommandList object common​

WP-CLI commands executed on the environment. Returns a cursor-based list payload.

AppEnvironment.commands.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.commands.first ● Int scalar common​

The maximum number of commands to return.

AppEnvironment.commands.order ● String scalar common​

The sort order to apply.

AppEnvironment.commands.page ● Int scalar common​

Page number to fetch.

AppEnvironment.commands.sort ● String scalar common​

The field to sort by.

AppEnvironment.commands.status ● String scalar common​

Filter commands by status.

AppEnvironment.commits ● GitCommitList object common​

The recent commits relevant to the environment.

AppEnvironment.commits.first ● Int scalar common​

The maximum number of commits to return.

AppEnvironment.createdAt ● String scalar common​

When the environment was created.

AppEnvironment.currentCommit ● String scalar common​

The current deployed commit SHA.

AppEnvironment.customErrorPageConfig ● CustomErrorPageConfig object common​

The custom error page configuration for the environment.

AppEnvironment.datacenter ● String scalar common​

The datacenter serving the environment.

AppEnvironment.dbBackupCopies ● DBBackupCopyList object common​

Database backup copies available for the environment.

AppEnvironment.dbBackupCopies.fileNames ● [String] list scalar common​

The backup file names to filter by.

AppEnvironment.dbOperationInProgress ● Boolean scalar common​

Whether a database operation is currently in progress.

AppEnvironment.defaultDomain ● String scalar common​

The default domain assigned to the environment.

AppEnvironment.defensiveMode ● AppEnvironmentDefensiveMode object common​

The defensive mode configuration and state.

AppEnvironment.defensiveMode.fromDate ● Date scalar common​

The start date for the defensive mode reporting window.

AppEnvironment.defensiveMode.toDate ● Date scalar common​

The end date for the defensive mode reporting window.

AppEnvironment.deploymentStrategy ● String scalar common​

The deployment strategy configured for the environment.

AppEnvironment.deployments ● DeploymentList object common​

The deployments for the environment. This is the richer deployment view and supports cursor pagination plus a legacy page argument.

AppEnvironment.deployments.first ● Int scalar common​

The maximum number of deployments to return.

AppEnvironment.deployments.id ● Int scalar common​

The deployment ID to retrieve.

AppEnvironment.deployments.nextCursor ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.deployments.page ● Int scalar common​

The page number to fetch.

AppEnvironment.deploys ● DeployList object common​

The recent deploy records for the environment. This is a lightweight/legacy view.

AppEnvironment.deploys.first ● Int scalar common​

The maximum number of deploys to return.

AppEnvironment.domains ● DomainList object common​

The domains mapped to the environment.

AppEnvironment.domains.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.domains.exclude ● [String] list scalar common​

Domain names to exclude from the results.

AppEnvironment.domains.first ● Int scalar common​

The maximum number of domains to return.

AppEnvironment.domains.isVerified ● Boolean scalar common​

Filter domains by verification status.

AppEnvironment.domains.matching ● String scalar common​

The free-text filter to match against domains.

AppEnvironment.domains.page ● Int scalar common​

Page number to fetch.

AppEnvironment.edgeConfig ● EdgeConfig object common​

The edge configuration for the environment.

AppEnvironment.edgeWorkers ● [EdgeWorker!]! non-null object common​

The WASM edge workers deployed to the environment.

AppEnvironment.environmentVariables ● EnvironmentVariablesList object common​

The environment variables configured for the environment.

AppEnvironment.events ● AuditEventList object common​

The audit events recorded for the environment. Returns an AuditEventList with total, nextCursor, and nodes/edges.

AppEnvironment.events.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.events.afterTs ● String scalar common​

Only include events after this timestamp.

AppEnvironment.events.beforeTs ● String scalar common​

Only include events before this timestamp.

AppEnvironment.events.excludeAnomalyEvents ● Boolean scalar common​

Whether to exclude anomaly events.

AppEnvironment.events.excludeEventTypePrefixes ● String scalar common​

Exclude event types matching this comma-separated list of prefixes.

AppEnvironment.events.excludeWPCLI ● Boolean scalar common​

Whether to exclude WP-CLI events.

AppEnvironment.events.first ● Int scalar common​

The maximum number of events to return.

AppEnvironment.events.types ● String scalar common​

Filter events by event types.

AppEnvironment.eventsCounts ● [AuditEventCount] list object common​

Counts of audit events for the environment.

AppEnvironment.eventsCounts.from ● String scalar common​

The start of the reporting window.

AppEnvironment.eventsCounts.to ● String scalar common​

The end of the reporting window.

AppEnvironment.eventsCounts.types ● [String] list scalar common​

The event types to include.

AppEnvironment.getIntegrationsDevEnvConfig ● IntegrationDevEnvConfig object common​

The development environment configuration for integrations.

AppEnvironment.health ● AppEnvironmentHealth object common​

Health metrics for the environment.

AppEnvironment.health.endDate ● String scalar common​

The end of the reporting window.

AppEnvironment.health.startDate ● String scalar common​

The start of the reporting window.

AppEnvironment.hstsSettings ● AppEnvironmentHSTSSettings object common​

The HSTS settings for the environment.

AppEnvironment.icon ● AppEnvironmentIcon object common​

The icon for the environment.

AppEnvironment.icon.size ● Int scalar common​

The requested icon size.

AppEnvironment.id ● Int scalar common​

The unique identifier for the environment.

AppEnvironment.importStatus ● AppEnvironmentImportStatus object common​

The current import status for the environment.

AppEnvironment.insightsOverview ● EnvironmentInsightsOverview object common​

An overview of insights and metrics for the environment over a date range.

AppEnvironment.insightsOverview.fromDate ● Date! non-null scalar common​

The start date for the overview window.

AppEnvironment.insightsOverview.toDate ● Date! non-null scalar common​

The end date for the overview window.

AppEnvironment.integration ● Integration object common​

A single integration configured for the environment.

AppEnvironment.integration.networkSiteId ● Int scalar common​

The network site ID for a network-scoped integration.

AppEnvironment.integration.slug ● String scalar common​

The integration slug.

AppEnvironment.integrations ● IntegrationList object common​

The integrations configured for the environment. Returns an IntegrationList where nodes are IntegrationListItem.

AppEnvironment.ips ● AppEnvironmentIPs object common​

The IP addresses assigned to the environment.

AppEnvironment.isDBPartitioningEnabled ● Boolean scalar common​

Whether database partitioning is enabled.

AppEnvironment.isFedramp ● Boolean scalar common​

Whether the environment is in a FedRAMP context.

AppEnvironment.isHipaa ● Boolean scalar common​

Whether the environment belongs to an organization with a signed BAA and must follow HIPAA requirements.

AppEnvironment.isK8sResident ● Boolean scalar common​

Whether the environment runs on Kubernetes.

AppEnvironment.isLiveBackupCopyAllowed ● Boolean scalar common​

Whether live backup copies are allowed for the environment.

AppEnvironment.isMultisite ● Boolean scalar common​

Whether the environment is a multisite install.

AppEnvironment.isOnLatestCode ● Boolean scalar common​

Whether the environment is running the latest deployed code.

AppEnvironment.isSubdirectoryMultisite ● Boolean scalar common​

Whether the multisite install uses subdirectories.

AppEnvironment.jobs ● [JobInterface] list interface common​

Jobs running on or related to the environment.

AppEnvironment.jobs.jobTypes ● [AppEnvironmentJobType!] list enum common​

The job types to filter by as enum values.

AppEnvironment.jobs.types ● [String!] list scalar common​

The job types to filter by as raw values.

AppEnvironment.latestBackup ● Backup object common​

The most recent backup for the environment.

AppEnvironment.latestMediaExport ● MediaExport object common​

The most recent media export for the environment.

AppEnvironment.launchModeEndAt ● String scalar common​

When launch mode ends for the environment.

AppEnvironment.launched ● Boolean scalar common​

Whether the environment has been launched.

AppEnvironment.liveBackupCopies ● [LiveBackupCopy] list object common​

The live backup copies for the environment.

AppEnvironment.logShippingConfig ● AppEnvironmentLogShippingV2 object common​

The current V2 log shipping configuration.

AppEnvironment.logs ● AppEnvironmentLogsList object common​

Application and platform logs for the environment. Use type: app or type: batch. Returns pollingDelaySeconds to guide incremental polling.

AppEnvironment.logs.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.logs.limit ● Int scalar common​

The maximum number of log entries to return.

AppEnvironment.logs.type ● AppEnvironmentLogType enum common​

The log stream to retrieve.

AppEnvironment.mediaExports ● MediaExportsList object common​

Media exports for the environment.

AppEnvironment.mediaExports.nextCursor ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.mediaImportStatus ● AppEnvironmentMediaImportStatus object common​

The current media import status for the environment.

AppEnvironment.metricAnomalies ● MetricAnomaliesList object common​

Metric anomalies detected for the environment.

AppEnvironment.metricAnomalies.algorithmVersion ● String scalar common​

The anomaly detection algorithm version.

AppEnvironment.metricAnomalies.excludeCustomAnomalies ● Boolean scalar common​

Whether to exclude custom anomalies.

AppEnvironment.metricAnomalies.fromDate ● Date scalar common​

The start date for the anomaly window.

AppEnvironment.metricAnomalies.metricName ● String scalar common​

The metric name to retrieve.

AppEnvironment.metricAnomalies.toDate ● Date scalar common​

The end date for the anomaly window.

AppEnvironment.metricThresholds ● [MetricThreshold] list object common​

The metric thresholds configured for the environment.

AppEnvironment.metricThresholds.metricName ● String scalar common​

The metric name to filter by.

AppEnvironment.metrics ● AggregatedMetricMeasurements object common​

Aggregated metrics for the environment.

AppEnvironment.metrics.aggregate ● Boolean scalar common​

Whether to aggregate the metric series.

AppEnvironment.metrics.fromDate ● Date scalar common​

The start date for the metric window.

AppEnvironment.metrics.includeBaseline ● Boolean scalar common​

Whether to include baseline data.

AppEnvironment.metrics.metricName ● String scalar common​

The metric name to retrieve.

AppEnvironment.metrics.toDate ● Date scalar common​

The end date for the metric window.

AppEnvironment.name ● String scalar common​

The display name of the environment.

AppEnvironment.newRelic ● AppEnvironmentNewRelic object common​

The New Relic configuration for the environment.

AppEnvironment.notificationSubscriptions ● NotificationSubscriptionList object common​

The notification subscriptions configured for the environment.

AppEnvironment.notificationSubscriptions.active ● Boolean scalar common​

Filter subscriptions by active status.

AppEnvironment.notificationSubscriptions.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.notificationSubscriptions.first ● Int scalar common​

The maximum number of subscriptions to return.

AppEnvironment.notificationSubscriptions.notificationRecipientId ● Int scalar common​

Filter subscriptions for a specific notification recipient.

AppEnvironment.permissions ● [PermissionResult] list object common​

Permission checks for the current user on this environment.

AppEnvironment.permissions.permissions ● [String] list scalar common​

The permission keys to evaluate.

AppEnvironment.phpMyAdminStatus ● PHPMyAdminStatus object common​

The phpMyAdmin availability status for the environment.

AppEnvironment.primaryDomain ● Domain object common​

The primary domain for the environment.

AppEnvironment.primaryDomainSwitchProgress ● AppEnvironmentPrimaryDomainSwitchProgress object common​

The progress of a primary domain switch.

AppEnvironment.primaryDomainSwitchProgress.primaryDomainSwitchId ● Int scalar common​

The primary domain switch job ID.

AppEnvironment.repo ● String scalar common​

The repository name for the environment's codebase.

AppEnvironment.repository ● GitRepository object common​

The repository for the environment.

AppEnvironment.requestStats ● RequestStatsList object common​

Request statistics for the environment.

AppEnvironment.requestStats.date ● String scalar common​

The single date to query.

AppEnvironment.requestStats.days ● Int scalar common​

The number of days to include.

AppEnvironment.requestStats.from ● String scalar common​

The start date for the reporting window.

AppEnvironment.requestStats.months ● Int scalar common​

The number of months to include.

AppEnvironment.requestStats.to ● String scalar common​

The end date for the reporting window.

AppEnvironment.slowlogs ● AppEnvironmentSlowlogsList object common​

Database slow query logs for the environment.

AppEnvironment.slowlogs.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.slowlogs.limit ● Int scalar common​

The maximum number of slow log entries to return.

AppEnvironment.software ● AppEnvironmentSoftwareDetails object common​

The software details for the environment.

AppEnvironment.softwareSettings ● AppEnvironmentSoftwareSettings object common​

The software settings for the environment.

AppEnvironment.syncPreview ● AppEnvironmentSyncPreview object common​

A preview of the next environment sync.

AppEnvironment.syncProgress ● AppEnvironmentSyncProgress object common​

The current sync progress for the environment.

AppEnvironment.syncProgress.sync ● Int scalar common​

The sync job ID.

AppEnvironment.type ● String scalar common​

The environment type, such as production or develop.

AppEnvironment.uniqueLabel ● String scalar common​

The unique label for the environment.

AppEnvironment.updateSubsiteDomainStatus ● AppEnvironmentUpdateSubsiteDomainStatus object common​

The current subsite domain update status.

AppEnvironment.wpInstallation ● WPInstallation object common​

Get WordPress Site Installation Details

AppEnvironment.wpSites ● WPSiteList object common​

Get WordPress Site Details

AppEnvironment.wpSites.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.wpSites.first ● Int scalar common​

The maximum number of WordPress sites to return.

AppEnvironment.wpSitesSDS ● WPSiteList object common​

Get WordPress Site Details from SDS

AppEnvironment.wpSitesSDS.after ● String scalar common​

The pagination cursor to continue from.

AppEnvironment.wpSitesSDS.blogId ● Int scalar common​

The blog ID to filter by.

AppEnvironment.wpSitesSDS.first ● Int scalar common​

The maximum number of WordPress sites to return.

AppEnvironment.wpSitesSDS.launchStatus ● WPSiteLaunchStatus enum common​

Filter sites by launch status.

AppEnvironment.wpSitesSDS.matching ● String scalar common​

The free-text filter to match against sites.

AppEnvironment.wpSitesSDS.order ● String scalar common​

The sort order to apply.

AppEnvironment.wpSitesSDS.page ● Int scalar common​

Page number to fetch.

AppEnvironment.wpSitesSDS.sort ● String scalar common​

The field to sort by.

AppEnvironment.wpcliStrategy ● AppEnvironmentWPCliStrategy enum common​

The strategy used to execute WP-CLI commands.

Member Of​

App object ● AppEnvironmentEnableLaunchModePayload object ● AppEnvironmentLaunchedPayload object ● AppEnvironmentPrimaryDomainSwitchPayload object ● AppEnvironmentSyncPayload object ● AppEnvironmentSyncPreview object ● AppEnvironmentUpdateSubsiteDomainPayload object ● AuditEvent object ● Domain object ● WPSiteLaunchStatusPayload object