Type alias APIEnvironment

APIEnvironment: {
    apiId: string;
    cors: APIEnvironmentCorsConfiguration | boolean;
    environment: string;
    formsAppEnvironmentIds?: number[];
    isWafEnabled?: boolean;
    lastDeployment: string;
    routes: APIEnvironmentRoute[];
    scheduledFunctions?: APIEnvironmentScheduledFunction[];
    status?: "Warning" | "Error" | "Okay" | "Unknown";
    vpcSecurityGroupIds?: string;
    vpcSubnetIds?: string;
}

Type declaration

  • apiId: string
  • cors: APIEnvironmentCorsConfiguration | boolean
  • environment: string
  • Optional formsAppEnvironmentIds?: number[]

    The IDs of the Forms App Environments to map this environment to. These are used for form migrations that include Hosted API configuration.

  • Optional isWafEnabled?: boolean
  • lastDeployment: string
  • routes: APIEnvironmentRoute[]
  • Optional scheduledFunctions?: APIEnvironmentScheduledFunction[]
  • Optional status?: "Warning" | "Error" | "Okay" | "Unknown"
  • Optional vpcSecurityGroupIds?: string
  • Optional vpcSubnetIds?: string