digitalocean-openapi-js
Version:
Generated JS from digitalocean v2 openapi spec
1,387 lines • 416 kB
TypeScript
import type { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
import type { RequestArgs } from "./base.js";
import { BaseAPI } from "./base.js";
import type { Configuration } from "./configuration.js";
export interface Account {
droplet_limit: number;
floating_ip_limit: number;
email: string;
name?: string;
uuid: string;
email_verified: boolean;
status: AccountStatusEnum;
status_message: string;
team?: AccountTeam;
}
export declare const AccountStatusEnum: {
readonly Active: "active";
readonly Warning: "warning";
readonly Locked: "locked";
};
export type AccountStatusEnum = (typeof AccountStatusEnum)[keyof typeof AccountStatusEnum];
export interface AccountGet200Response {
account?: Account;
}
export interface AccountTeam {
uuid?: string;
name?: string;
}
export interface Action {
id?: number;
status?: ActionStatusEnum;
type?: string;
started_at?: string;
completed_at?: string | null;
resource_id?: number | null;
resource_type?: string;
region?: Region;
region_slug?: string;
}
export declare const ActionStatusEnum: {
readonly InProgress: "in-progress";
readonly Completed: "completed";
readonly Errored: "errored";
};
export type ActionStatusEnum = (typeof ActionStatusEnum)[keyof typeof ActionStatusEnum];
export interface ActionLink {
id?: number;
rel?: string;
href?: string;
}
export interface ActionsGet200Response {
action?: Action;
}
export interface ActionsList200Response {
links?: PageLinks;
meta: MetaMeta;
actions?: Array<Action>;
}
export interface Alert {
id?: string;
name?: string;
type?: AlertTypeEnum;
threshold?: number;
comparison?: AlertComparisonEnum;
notifications?: Notification;
period?: AlertPeriodEnum;
}
export declare const AlertTypeEnum: {
readonly Latency: "latency";
readonly Down: "down";
readonly DownGlobal: "down_global";
readonly SslExpiry: "ssl_expiry";
};
export type AlertTypeEnum = (typeof AlertTypeEnum)[keyof typeof AlertTypeEnum];
export declare const AlertComparisonEnum: {
readonly GreaterThan: "greater_than";
readonly LessThan: "less_than";
};
export type AlertComparisonEnum = (typeof AlertComparisonEnum)[keyof typeof AlertComparisonEnum];
export declare const AlertPeriodEnum: {
readonly _2m: "2m";
readonly _3m: "3m";
readonly _5m: "5m";
readonly _10m: "10m";
readonly _15m: "15m";
readonly _30m: "30m";
readonly _1h: "1h";
};
export type AlertPeriodEnum = (typeof AlertPeriodEnum)[keyof typeof AlertPeriodEnum];
export interface AlertBase {
id?: string;
}
export interface AlertPolicy {
alerts: Alerts;
compare: AlertPolicyCompareEnum;
description: string;
enabled: boolean;
entities: Array<string>;
tags: Array<string>;
type: AlertPolicyTypeEnum;
uuid: string;
value: number;
window: AlertPolicyWindowEnum;
}
export declare const AlertPolicyCompareEnum: {
readonly GreaterThan: "GreaterThan";
readonly LessThan: "LessThan";
};
export type AlertPolicyCompareEnum = (typeof AlertPolicyCompareEnum)[keyof typeof AlertPolicyCompareEnum];
export declare const AlertPolicyTypeEnum: {
readonly InsightsDropletLoad1: "v1/insights/droplet/load_1";
readonly InsightsDropletLoad5: "v1/insights/droplet/load_5";
readonly InsightsDropletLoad15: "v1/insights/droplet/load_15";
readonly InsightsDropletMemoryUtilizationPercent: "v1/insights/droplet/memory_utilization_percent";
readonly InsightsDropletDiskUtilizationPercent: "v1/insights/droplet/disk_utilization_percent";
readonly InsightsDropletCpu: "v1/insights/droplet/cpu";
readonly InsightsDropletDiskRead: "v1/insights/droplet/disk_read";
readonly InsightsDropletDiskWrite: "v1/insights/droplet/disk_write";
readonly InsightsDropletPublicOutboundBandwidth: "v1/insights/droplet/public_outbound_bandwidth";
readonly InsightsDropletPublicInboundBandwidth: "v1/insights/droplet/public_inbound_bandwidth";
readonly InsightsDropletPrivateOutboundBandwidth: "v1/insights/droplet/private_outbound_bandwidth";
readonly InsightsDropletPrivateInboundBandwidth: "v1/insights/droplet/private_inbound_bandwidth";
readonly InsightsLbaasAvgCpuUtilizationPercent: "v1/insights/lbaas/avg_cpu_utilization_percent";
readonly InsightsLbaasConnectionUtilizationPercent: "v1/insights/lbaas/connection_utilization_percent";
readonly InsightsLbaasDropletHealth: "v1/insights/lbaas/droplet_health";
readonly InsightsLbaasTlsConnectionsPerSecondUtilizationPercent: "v1/insights/lbaas/tls_connections_per_second_utilization_percent";
readonly InsightsLbaasIncreaseInHttpErrorRatePercentage5xx: "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx";
readonly InsightsLbaasIncreaseInHttpErrorRatePercentage4xx: "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx";
readonly InsightsLbaasIncreaseInHttpErrorRateCount5xx: "v1/insights/lbaas/increase_in_http_error_rate_count_5xx";
readonly InsightsLbaasIncreaseInHttpErrorRateCount4xx: "v1/insights/lbaas/increase_in_http_error_rate_count_4xx";
readonly InsightsLbaasHighHttpRequestResponseTime: "v1/insights/lbaas/high_http_request_response_time";
readonly InsightsLbaasHighHttpRequestResponseTime50p: "v1/insights/lbaas/high_http_request_response_time_50p";
readonly InsightsLbaasHighHttpRequestResponseTime95p: "v1/insights/lbaas/high_http_request_response_time_95p";
readonly InsightsLbaasHighHttpRequestResponseTime99p: "v1/insights/lbaas/high_http_request_response_time_99p";
readonly DbaasAlertsLoad15Alerts: "v1/dbaas/alerts/load_15_alerts";
readonly DbaasAlertsMemoryUtilizationAlerts: "v1/dbaas/alerts/memory_utilization_alerts";
readonly DbaasAlertsDiskUtilizationAlerts: "v1/dbaas/alerts/disk_utilization_alerts";
readonly DbaasAlertsCpuAlerts: "v1/dbaas/alerts/cpu_alerts";
};
export type AlertPolicyTypeEnum = (typeof AlertPolicyTypeEnum)[keyof typeof AlertPolicyTypeEnum];
export declare const AlertPolicyWindowEnum: {
readonly _5m: "5m";
readonly _10m: "10m";
readonly _30m: "30m";
readonly _1h: "1h";
};
export type AlertPolicyWindowEnum = (typeof AlertPolicyWindowEnum)[keyof typeof AlertPolicyWindowEnum];
export interface AlertPolicyRequest {
alerts: Alerts;
compare: AlertPolicyRequestCompareEnum;
description: string;
enabled: boolean;
entities: Array<string>;
tags: Array<string>;
type: AlertPolicyRequestTypeEnum;
value: number;
window: AlertPolicyRequestWindowEnum;
}
export declare const AlertPolicyRequestCompareEnum: {
readonly GreaterThan: "GreaterThan";
readonly LessThan: "LessThan";
};
export type AlertPolicyRequestCompareEnum = (typeof AlertPolicyRequestCompareEnum)[keyof typeof AlertPolicyRequestCompareEnum];
export declare const AlertPolicyRequestTypeEnum: {
readonly InsightsDropletLoad1: "v1/insights/droplet/load_1";
readonly InsightsDropletLoad5: "v1/insights/droplet/load_5";
readonly InsightsDropletLoad15: "v1/insights/droplet/load_15";
readonly InsightsDropletMemoryUtilizationPercent: "v1/insights/droplet/memory_utilization_percent";
readonly InsightsDropletDiskUtilizationPercent: "v1/insights/droplet/disk_utilization_percent";
readonly InsightsDropletCpu: "v1/insights/droplet/cpu";
readonly InsightsDropletDiskRead: "v1/insights/droplet/disk_read";
readonly InsightsDropletDiskWrite: "v1/insights/droplet/disk_write";
readonly InsightsDropletPublicOutboundBandwidth: "v1/insights/droplet/public_outbound_bandwidth";
readonly InsightsDropletPublicInboundBandwidth: "v1/insights/droplet/public_inbound_bandwidth";
readonly InsightsDropletPrivateOutboundBandwidth: "v1/insights/droplet/private_outbound_bandwidth";
readonly InsightsDropletPrivateInboundBandwidth: "v1/insights/droplet/private_inbound_bandwidth";
readonly InsightsLbaasAvgCpuUtilizationPercent: "v1/insights/lbaas/avg_cpu_utilization_percent";
readonly InsightsLbaasConnectionUtilizationPercent: "v1/insights/lbaas/connection_utilization_percent";
readonly InsightsLbaasDropletHealth: "v1/insights/lbaas/droplet_health";
readonly InsightsLbaasTlsConnectionsPerSecondUtilizationPercent: "v1/insights/lbaas/tls_connections_per_second_utilization_percent";
readonly InsightsLbaasIncreaseInHttpErrorRatePercentage5xx: "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx";
readonly InsightsLbaasIncreaseInHttpErrorRatePercentage4xx: "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx";
readonly InsightsLbaasIncreaseInHttpErrorRateCount5xx: "v1/insights/lbaas/increase_in_http_error_rate_count_5xx";
readonly InsightsLbaasIncreaseInHttpErrorRateCount4xx: "v1/insights/lbaas/increase_in_http_error_rate_count_4xx";
readonly InsightsLbaasHighHttpRequestResponseTime: "v1/insights/lbaas/high_http_request_response_time";
readonly InsightsLbaasHighHttpRequestResponseTime50p: "v1/insights/lbaas/high_http_request_response_time_50p";
readonly InsightsLbaasHighHttpRequestResponseTime95p: "v1/insights/lbaas/high_http_request_response_time_95p";
readonly InsightsLbaasHighHttpRequestResponseTime99p: "v1/insights/lbaas/high_http_request_response_time_99p";
readonly DbaasAlertsLoad15Alerts: "v1/dbaas/alerts/load_15_alerts";
readonly DbaasAlertsMemoryUtilizationAlerts: "v1/dbaas/alerts/memory_utilization_alerts";
readonly DbaasAlertsDiskUtilizationAlerts: "v1/dbaas/alerts/disk_utilization_alerts";
readonly DbaasAlertsCpuAlerts: "v1/dbaas/alerts/cpu_alerts";
};
export type AlertPolicyRequestTypeEnum = (typeof AlertPolicyRequestTypeEnum)[keyof typeof AlertPolicyRequestTypeEnum];
export declare const AlertPolicyRequestWindowEnum: {
readonly _5m: "5m";
readonly _10m: "10m";
readonly _30m: "30m";
readonly _1h: "1h";
};
export type AlertPolicyRequestWindowEnum = (typeof AlertPolicyRequestWindowEnum)[keyof typeof AlertPolicyRequestWindowEnum];
export interface AlertUpdatable {
name?: string;
type?: AlertUpdatableTypeEnum;
threshold?: number;
comparison?: AlertUpdatableComparisonEnum;
notifications?: Notification;
period?: AlertUpdatablePeriodEnum;
}
export declare const AlertUpdatableTypeEnum: {
readonly Latency: "latency";
readonly Down: "down";
readonly DownGlobal: "down_global";
readonly SslExpiry: "ssl_expiry";
};
export type AlertUpdatableTypeEnum = (typeof AlertUpdatableTypeEnum)[keyof typeof AlertUpdatableTypeEnum];
export declare const AlertUpdatableComparisonEnum: {
readonly GreaterThan: "greater_than";
readonly LessThan: "less_than";
};
export type AlertUpdatableComparisonEnum = (typeof AlertUpdatableComparisonEnum)[keyof typeof AlertUpdatableComparisonEnum];
export declare const AlertUpdatablePeriodEnum: {
readonly _2m: "2m";
readonly _3m: "3m";
readonly _5m: "5m";
readonly _10m: "10m";
readonly _15m: "15m";
readonly _30m: "30m";
readonly _1h: "1h";
};
export type AlertUpdatablePeriodEnum = (typeof AlertUpdatablePeriodEnum)[keyof typeof AlertUpdatablePeriodEnum];
export interface Alerts {
email: Array<string>;
slack: Array<SlackDetails>;
}
export interface App {
active_deployment?: AppsDeployment;
created_at?: string;
default_ingress?: string;
domains?: Array<AppsDomain>;
id?: string;
in_progress_deployment?: AppsDeployment;
last_deployment_created_at?: string;
live_domain?: string;
live_url?: string;
live_url_base?: string;
owner_uuid?: string;
pending_deployment?: AppPendingDeployment;
project_id?: string;
region?: AppsRegion;
spec: AppSpec;
tier_slug?: string;
updated_at?: string;
pinned_deployment?: AppPinnedDeployment;
dedicated_ips?: Array<AppsDedicatedEgressIp>;
}
export interface AppAlert {
id?: string;
component_name?: string;
spec?: AppAlertSpec;
emails?: Array<string>;
slack_webhooks?: Array<AppAlertSlackWebhook>;
phase?: AppAlertPhase;
progress?: AppAlertProgress;
}
export declare const AppAlertPhase: {
readonly Unknown: "UNKNOWN";
readonly Pending: "PENDING";
readonly Configuring: "CONFIGURING";
readonly Active: "ACTIVE";
readonly Error: "ERROR";
};
export type AppAlertPhase = (typeof AppAlertPhase)[keyof typeof AppAlertPhase];
export interface AppAlertProgress {
steps?: Array<AppAlertProgressStep>;
}
export interface AppAlertProgressStep {
name?: string;
status?: AppAlertProgressStepStatus;
started_at?: string;
ended_at?: string;
reason?: AppAlertProgressStepReason;
}
export interface AppAlertProgressStepReason {
code?: string;
message?: string;
}
export declare const AppAlertProgressStepStatus: {
readonly Unknown: "UNKNOWN";
readonly Pending: "PENDING";
readonly Running: "RUNNING";
readonly Error: "ERROR";
readonly Success: "SUCCESS";
};
export type AppAlertProgressStepStatus = (typeof AppAlertProgressStepStatus)[keyof typeof AppAlertProgressStepStatus];
export interface AppAlertSlackWebhook {
url?: string;
channel?: string;
}
export interface AppAlertSpec {
rule?: AppAlertSpecRule;
disabled?: boolean;
operator?: AppAlertSpecOperator;
value?: number;
window?: AppAlertSpecWindow;
}
export declare const AppAlertSpecOperator: {
readonly UnspecifiedOperator: "UNSPECIFIED_OPERATOR";
readonly GreaterThan: "GREATER_THAN";
readonly LessThan: "LESS_THAN";
};
export type AppAlertSpecOperator = (typeof AppAlertSpecOperator)[keyof typeof AppAlertSpecOperator];
export declare const AppAlertSpecRule: {
readonly UnspecifiedRule: "UNSPECIFIED_RULE";
readonly CpuUtilization: "CPU_UTILIZATION";
readonly MemUtilization: "MEM_UTILIZATION";
readonly RestartCount: "RESTART_COUNT";
readonly DeploymentFailed: "DEPLOYMENT_FAILED";
readonly DeploymentLive: "DEPLOYMENT_LIVE";
readonly DomainFailed: "DOMAIN_FAILED";
readonly DomainLive: "DOMAIN_LIVE";
readonly FunctionsActivationCount: "FUNCTIONS_ACTIVATION_COUNT";
readonly FunctionsAverageDurationMs: "FUNCTIONS_AVERAGE_DURATION_MS";
readonly FunctionsErrorRatePerMinute: "FUNCTIONS_ERROR_RATE_PER_MINUTE";
readonly FunctionsAverageWaitTimeMs: "FUNCTIONS_AVERAGE_WAIT_TIME_MS";
readonly FunctionsErrorCount: "FUNCTIONS_ERROR_COUNT";
readonly FunctionsGbRatePerSecond: "FUNCTIONS_GB_RATE_PER_SECOND";
};
export type AppAlertSpecRule = (typeof AppAlertSpecRule)[keyof typeof AppAlertSpecRule];
export declare const AppAlertSpecWindow: {
readonly UnspecifiedWindow: "UNSPECIFIED_WINDOW";
readonly FiveMinutes: "FIVE_MINUTES";
readonly TenMinutes: "TEN_MINUTES";
readonly ThirtyMinutes: "THIRTY_MINUTES";
readonly OneHour: "ONE_HOUR";
};
export type AppAlertSpecWindow = (typeof AppAlertSpecWindow)[keyof typeof AppAlertSpecWindow];
export interface AppComponentBase {
name?: string;
git?: AppsGitSourceSpec;
github?: AppsGithubSourceSpec;
gitlab?: AppsGitlabSourceSpec;
image?: AppsImageSourceSpec;
dockerfile_path?: string;
build_command?: string;
run_command?: string;
source_dir?: string;
envs?: Array<AppVariableDefinition>;
environment_slug?: string;
log_destinations?: Array<AppLogDestinationDefinition>;
}
export interface AppComponentInstanceBase {
instance_count?: number;
instance_size_slug?: AppComponentInstanceBaseInstanceSizeSlugEnum;
autoscaling?: AppComponentInstanceBaseAutoscaling;
}
export declare const AppComponentInstanceBaseInstanceSizeSlugEnum: {
readonly S1vcpu05gb: "apps-s-1vcpu-0.5gb";
readonly S1vcpu1gbFixed: "apps-s-1vcpu-1gb-fixed";
readonly S1vcpu1gb: "apps-s-1vcpu-1gb";
readonly S1vcpu2gb: "apps-s-1vcpu-2gb";
readonly S2vcpu4gb: "apps-s-2vcpu-4gb";
readonly D1vcpu05gb: "apps-d-1vcpu-0.5gb";
readonly D1vcpu1gb: "apps-d-1vcpu-1gb";
readonly D1vcpu2gb: "apps-d-1vcpu-2gb";
readonly D1vcpu4gb: "apps-d-1vcpu-4gb";
readonly D2vcpu4gb: "apps-d-2vcpu-4gb";
readonly D2vcpu8gb: "apps-d-2vcpu-8gb";
readonly D4vcpu8gb: "apps-d-4vcpu-8gb";
readonly D4vcpu16gb: "apps-d-4vcpu-16gb";
readonly D8vcpu32gb: "apps-d-8vcpu-32gb";
};
export type AppComponentInstanceBaseInstanceSizeSlugEnum = (typeof AppComponentInstanceBaseInstanceSizeSlugEnum)[keyof typeof AppComponentInstanceBaseInstanceSizeSlugEnum];
export interface AppComponentInstanceBaseAutoscaling {
min_instance_count?: number;
max_instance_count?: number;
metrics?: AppComponentInstanceBaseAutoscalingMetrics;
}
export interface AppComponentInstanceBaseAutoscalingMetrics {
cpu?: AppComponentInstanceBaseAutoscalingMetricsCpu;
}
export interface AppComponentInstanceBaseAutoscalingMetricsCpu {
percent?: number;
}
export interface AppDatabaseSpec {
cluster_name?: string;
db_name?: string;
db_user?: string;
engine?: AppDatabaseSpecEngineEnum;
name: string;
production?: boolean;
version?: string;
}
export declare const AppDatabaseSpecEngineEnum: {
readonly Unset: "UNSET";
readonly Mysql: "MYSQL";
readonly Pg: "PG";
readonly Redis: "REDIS";
readonly Mongodb: "MONGODB";
readonly Kafka: "KAFKA";
readonly Opensearch: "OPENSEARCH";
};
export type AppDatabaseSpecEngineEnum = (typeof AppDatabaseSpecEngineEnum)[keyof typeof AppDatabaseSpecEngineEnum];
export interface AppDomainSpec {
domain: string;
type?: AppDomainSpecTypeEnum;
wildcard?: boolean;
zone?: string;
minimum_tls_version?: AppDomainSpecMinimumTlsVersionEnum;
}
export declare const AppDomainSpecTypeEnum: {
readonly Unspecified: "UNSPECIFIED";
readonly Default: "DEFAULT";
readonly Primary: "PRIMARY";
readonly Alias: "ALIAS";
};
export type AppDomainSpecTypeEnum = (typeof AppDomainSpecTypeEnum)[keyof typeof AppDomainSpecTypeEnum];
export declare const AppDomainSpecMinimumTlsVersionEnum: {
readonly _2: "1.2";
readonly _3: "1.3";
};
export type AppDomainSpecMinimumTlsVersionEnum = (typeof AppDomainSpecMinimumTlsVersionEnum)[keyof typeof AppDomainSpecMinimumTlsVersionEnum];
export interface AppDomainValidation {
txt_name?: string;
txt_value?: string;
}
export interface AppEgressSpec {
type?: AppEgressTypeSpec;
}
export declare const AppEgressTypeSpec: {
readonly Autoassign: "AUTOASSIGN";
readonly DedicatedIp: "DEDICATED_IP";
};
export type AppEgressTypeSpec = (typeof AppEgressTypeSpec)[keyof typeof AppEgressTypeSpec];
export interface AppFunctionsSpec {
cors?: AppStaticSiteSpecAllOfCors;
routes?: Array<AppRouteSpec>;
name: string;
source_dir?: string;
alerts?: Array<AppAlertSpec>;
envs?: Array<AppVariableDefinition>;
git?: AppsGitSourceSpec;
github?: AppsGithubSourceSpec;
gitlab?: AppsGitlabSourceSpec;
log_destinations?: Array<AppLogDestinationDefinition>;
}
export interface AppIngressSpec {
rules?: Array<AppIngressSpecRule>;
}
export interface AppIngressSpecRule {
match?: AppIngressSpecRuleMatch;
cors?: AppsCorsPolicy;
component?: AppIngressSpecRuleRoutingComponent;
redirect?: AppIngressSpecRuleRoutingRedirect;
}
export interface AppIngressSpecRuleMatch {
path: AppIngressSpecRuleStringMatch;
}
export interface AppIngressSpecRuleRoutingComponent {
name: string;
preserve_path_prefix?: string;
rewrite?: string;
}
export interface AppIngressSpecRuleRoutingRedirect {
uri?: string;
authority?: string;
port?: number;
scheme?: string;
redirect_code?: number;
}
export interface AppIngressSpecRuleStringMatch {
prefix: string;
}
export interface AppJobSpec {
name: string;
git?: AppsGitSourceSpec;
github?: AppsGithubSourceSpec;
gitlab?: AppsGitlabSourceSpec;
image?: AppsImageSourceSpec;
dockerfile_path?: string;
build_command?: string;
run_command?: string;
source_dir?: string;
envs?: Array<AppVariableDefinition>;
environment_slug?: string;
log_destinations?: Array<AppLogDestinationDefinition>;
instance_count?: number;
instance_size_slug?: AppJobSpecInstanceSizeSlugEnum;
autoscaling?: AppComponentInstanceBaseAutoscaling;
kind?: AppJobSpecKindEnum;
termination?: AppJobSpecTermination;
}
export declare const AppJobSpecInstanceSizeSlugEnum: {
readonly S1vcpu05gb: "apps-s-1vcpu-0.5gb";
readonly S1vcpu1gbFixed: "apps-s-1vcpu-1gb-fixed";
readonly S1vcpu1gb: "apps-s-1vcpu-1gb";
readonly S1vcpu2gb: "apps-s-1vcpu-2gb";
readonly S2vcpu4gb: "apps-s-2vcpu-4gb";
readonly D1vcpu05gb: "apps-d-1vcpu-0.5gb";
readonly D1vcpu1gb: "apps-d-1vcpu-1gb";
readonly D1vcpu2gb: "apps-d-1vcpu-2gb";
readonly D1vcpu4gb: "apps-d-1vcpu-4gb";
readonly D2vcpu4gb: "apps-d-2vcpu-4gb";
readonly D2vcpu8gb: "apps-d-2vcpu-8gb";
readonly D4vcpu8gb: "apps-d-4vcpu-8gb";
readonly D4vcpu16gb: "apps-d-4vcpu-16gb";
readonly D8vcpu32gb: "apps-d-8vcpu-32gb";
};
export type AppJobSpecInstanceSizeSlugEnum = (typeof AppJobSpecInstanceSizeSlugEnum)[keyof typeof AppJobSpecInstanceSizeSlugEnum];
export declare const AppJobSpecKindEnum: {
readonly Unspecified: "UNSPECIFIED";
readonly PreDeploy: "PRE_DEPLOY";
readonly PostDeploy: "POST_DEPLOY";
readonly FailedDeploy: "FAILED_DEPLOY";
};
export type AppJobSpecKindEnum = (typeof AppJobSpecKindEnum)[keyof typeof AppJobSpecKindEnum];
export interface AppJobSpecTermination {
grace_period_seconds?: number;
}
export interface AppLogDestinationDatadogSpec {
endpoint?: string;
api_key: string;
}
export interface AppLogDestinationDefinition {
name: string;
papertrail?: AppLogDestinationPapertrailSpec;
datadog?: AppLogDestinationDatadogSpec;
logtail?: AppLogDestinationLogtailSpec;
open_search?: AppLogDestinationOpenSearchSpec;
}
export interface AppLogDestinationLogtailSpec {
token?: string;
}
export interface AppLogDestinationOpenSearchSpec {
endpoint?: string;
basic_auth?: AppLogDestinationOpenSearchSpecBasicAuth;
index_name?: string;
cluster_name?: string;
}
export interface AppLogDestinationOpenSearchSpecBasicAuth {
user?: string;
password?: any;
}
export interface AppLogDestinationPapertrailSpec {
endpoint: string;
}
export interface AppMetricsBandwidthUsage {
app_bandwidth_usage?: Array<AppMetricsBandwidthUsageDetails>;
date?: string;
}
export interface AppMetricsBandwidthUsageDetails {
app_id?: string;
bandwidth_bytes?: string;
}
export interface AppMetricsBandwidthUsageRequest {
app_ids: Array<string>;
date?: string;
}
export interface AppPendingDeployment {
cause?: string;
cloned_from?: string;
created_at?: string;
id?: string;
jobs?: Array<AppsDeploymentJob>;
functions?: Array<AppsDeploymentFunctions>;
phase?: AppsDeploymentPhase;
phase_last_updated_at?: string;
progress?: AppsDeploymentProgress;
services?: Array<AppsDeploymentService>;
spec?: AppSpec;
static_sites?: Array<AppsDeploymentStaticSite>;
tier_slug?: string;
updated_at?: string;
workers?: Array<AppsDeploymentWorker>;
}
export interface AppPinnedDeployment {
cause?: string;
cloned_from?: string;
created_at?: string;
id?: string;
jobs?: Array<AppsDeploymentJob>;
functions?: Array<AppsDeploymentFunctions>;
phase?: AppsDeploymentPhase;
phase_last_updated_at?: string;
progress?: AppsDeploymentProgress;
services?: Array<AppsDeploymentService>;
spec?: AppSpec;
static_sites?: Array<AppsDeploymentStaticSite>;
tier_slug?: string;
updated_at?: string;
workers?: Array<AppsDeploymentWorker>;
}
export interface AppPropose {
spec: AppSpec;
app_id?: string;
}
export interface AppProposeResponse {
app_is_static?: boolean;
app_name_available?: boolean;
app_name_suggestion?: string;
existing_static_apps?: string;
spec?: AppSpec;
app_cost?: number;
app_tier_downgrade_cost?: number;
}
export interface AppResponse {
app?: App;
}
export interface AppRollbackValidationCondition {
code?: AppRollbackValidationConditionCodeEnum;
message?: string;
components?: Array<string>;
}
export declare const AppRollbackValidationConditionCodeEnum: {
readonly IncompatiblePhase: "incompatible_phase";
readonly IncompatibleResult: "incompatible_result";
readonly ExceededRevisionLimit: "exceeded_revision_limit";
readonly AppPinned: "app_pinned";
readonly DatabaseConfigConflict: "database_config_conflict";
readonly RegionConflict: "region_conflict";
readonly StaticSiteRequiresRebuild: "static_site_requires_rebuild";
readonly ImageSourceMissingDigest: "image_source_missing_digest";
};
export type AppRollbackValidationConditionCodeEnum = (typeof AppRollbackValidationConditionCodeEnum)[keyof typeof AppRollbackValidationConditionCodeEnum];
export interface AppRouteSpec {
path?: string;
preserve_path_prefix?: boolean;
}
export interface AppServiceSpec {
name: string;
git?: AppsGitSourceSpec;
github?: AppsGithubSourceSpec;
gitlab?: AppsGitlabSourceSpec;
image?: AppsImageSourceSpec;
dockerfile_path?: string;
build_command?: string;
run_command?: string;
source_dir?: string;
envs?: Array<AppVariableDefinition>;
environment_slug?: string;
log_destinations?: Array<AppLogDestinationDefinition>;
instance_count?: number;
instance_size_slug?: AppServiceSpecInstanceSizeSlugEnum;
autoscaling?: AppComponentInstanceBaseAutoscaling;
cors?: AppServiceSpecAllOfCors;
health_check?: AppServiceSpecHealthCheck;
http_port?: number;
internal_ports?: Array<number>;
routes?: Array<AppRouteSpec>;
termination?: AppServiceSpecTermination;
}
export declare const AppServiceSpecInstanceSizeSlugEnum: {
readonly S1vcpu05gb: "apps-s-1vcpu-0.5gb";
readonly S1vcpu1gbFixed: "apps-s-1vcpu-1gb-fixed";
readonly S1vcpu1gb: "apps-s-1vcpu-1gb";
readonly S1vcpu2gb: "apps-s-1vcpu-2gb";
readonly S2vcpu4gb: "apps-s-2vcpu-4gb";
readonly D1vcpu05gb: "apps-d-1vcpu-0.5gb";
readonly D1vcpu1gb: "apps-d-1vcpu-1gb";
readonly D1vcpu2gb: "apps-d-1vcpu-2gb";
readonly D1vcpu4gb: "apps-d-1vcpu-4gb";
readonly D2vcpu4gb: "apps-d-2vcpu-4gb";
readonly D2vcpu8gb: "apps-d-2vcpu-8gb";
readonly D4vcpu8gb: "apps-d-4vcpu-8gb";
readonly D4vcpu16gb: "apps-d-4vcpu-16gb";
readonly D8vcpu32gb: "apps-d-8vcpu-32gb";
};
export type AppServiceSpecInstanceSizeSlugEnum = (typeof AppServiceSpecInstanceSizeSlugEnum)[keyof typeof AppServiceSpecInstanceSizeSlugEnum];
export interface AppServiceSpecAllOfCors {
allow_origins?: Array<AppsStringMatch>;
allow_methods?: Array<string>;
allow_headers?: Array<string>;
expose_headers?: Array<string>;
max_age?: string;
allow_credentials?: boolean;
}
export interface AppServiceSpecHealthCheck {
failure_threshold?: number;
port?: number;
http_path?: string;
initial_delay_seconds?: number;
period_seconds?: number;
success_threshold?: number;
timeout_seconds?: number;
}
export interface AppServiceSpecTermination {
drain_seconds?: number;
grace_period_seconds?: number;
}
export interface AppSpec {
name: string;
region?: AppSpecRegionEnum;
domains?: Array<AppDomainSpec>;
services?: Array<AppServiceSpec>;
static_sites?: Array<AppStaticSiteSpec>;
jobs?: Array<AppJobSpec>;
workers?: Array<AppWorkerSpec>;
functions?: Array<AppFunctionsSpec>;
databases?: Array<AppDatabaseSpec>;
ingress?: AppIngressSpec;
egress?: AppEgressSpec;
}
export declare const AppSpecRegionEnum: {
readonly Ams: "ams";
readonly Nyc: "nyc";
readonly Fra: "fra";
readonly Sfo: "sfo";
readonly Sgp: "sgp";
readonly Blr: "blr";
readonly Tor: "tor";
readonly Lon: "lon";
readonly Syd: "syd";
};
export type AppSpecRegionEnum = (typeof AppSpecRegionEnum)[keyof typeof AppSpecRegionEnum];
export interface AppStaticSiteSpec {
name: string;
git?: AppsGitSourceSpec;
github?: AppsGithubSourceSpec;
gitlab?: AppsGitlabSourceSpec;
image?: AppsImageSourceSpec;
dockerfile_path?: string;
build_command?: string;
run_command?: string;
source_dir?: string;
envs?: Array<AppVariableDefinition>;
environment_slug?: string;
log_destinations?: Array<AppLogDestinationDefinition>;
index_document?: string;
error_document?: string;
catchall_document?: string;
output_dir?: string;
cors?: AppStaticSiteSpecAllOfCors;
routes?: Array<AppRouteSpec>;
}
export interface AppStaticSiteSpecAllOfCors {
allow_origins?: Array<AppsStringMatch>;
allow_methods?: Array<string>;
allow_headers?: Array<string>;
expose_headers?: Array<string>;
max_age?: string;
allow_credentials?: boolean;
}
export interface AppVariableDefinition {
key: string;
scope?: AppVariableDefinitionScopeEnum;
type?: AppVariableDefinitionTypeEnum;
value?: string;
}
export declare const AppVariableDefinitionScopeEnum: {
readonly Unset: "UNSET";
readonly RunTime: "RUN_TIME";
readonly BuildTime: "BUILD_TIME";
readonly RunAndBuildTime: "RUN_AND_BUILD_TIME";
};
export type AppVariableDefinitionScopeEnum = (typeof AppVariableDefinitionScopeEnum)[keyof typeof AppVariableDefinitionScopeEnum];
export declare const AppVariableDefinitionTypeEnum: {
readonly General: "GENERAL";
readonly Secret: "SECRET";
};
export type AppVariableDefinitionTypeEnum = (typeof AppVariableDefinitionTypeEnum)[keyof typeof AppVariableDefinitionTypeEnum];
export interface AppWorkerSpec {
name: string;
git?: AppsGitSourceSpec;
github?: AppsGithubSourceSpec;
gitlab?: AppsGitlabSourceSpec;
image?: AppsImageSourceSpec;
dockerfile_path?: string;
build_command?: string;
run_command?: string;
source_dir?: string;
envs?: Array<AppVariableDefinition>;
environment_slug?: string;
log_destinations?: Array<AppLogDestinationDefinition>;
instance_count?: number;
instance_size_slug?: AppWorkerSpecInstanceSizeSlugEnum;
autoscaling?: AppComponentInstanceBaseAutoscaling;
termination?: AppWorkerSpecTermination;
}
export declare const AppWorkerSpecInstanceSizeSlugEnum: {
readonly S1vcpu05gb: "apps-s-1vcpu-0.5gb";
readonly S1vcpu1gbFixed: "apps-s-1vcpu-1gb-fixed";
readonly S1vcpu1gb: "apps-s-1vcpu-1gb";
readonly S1vcpu2gb: "apps-s-1vcpu-2gb";
readonly S2vcpu4gb: "apps-s-2vcpu-4gb";
readonly D1vcpu05gb: "apps-d-1vcpu-0.5gb";
readonly D1vcpu1gb: "apps-d-1vcpu-1gb";
readonly D1vcpu2gb: "apps-d-1vcpu-2gb";
readonly D1vcpu4gb: "apps-d-1vcpu-4gb";
readonly D2vcpu4gb: "apps-d-2vcpu-4gb";
readonly D2vcpu8gb: "apps-d-2vcpu-8gb";
readonly D4vcpu8gb: "apps-d-4vcpu-8gb";
readonly D4vcpu16gb: "apps-d-4vcpu-16gb";
readonly D8vcpu32gb: "apps-d-8vcpu-32gb";
};
export type AppWorkerSpecInstanceSizeSlugEnum = (typeof AppWorkerSpecInstanceSizeSlugEnum)[keyof typeof AppWorkerSpecInstanceSizeSlugEnum];
export interface AppWorkerSpecTermination {
grace_period_seconds?: number;
}
export interface AppsAlertResponse {
alert?: AppAlert;
}
export interface AppsAssignAppAlertDestinationsRequest {
emails?: Array<string>;
slack_webhooks?: Array<AppAlertSlackWebhook>;
}
export interface AppsCorsPolicy {
allow_origins?: Array<AppsStringMatch>;
allow_methods?: Array<string>;
allow_headers?: Array<string>;
expose_headers?: Array<string>;
max_age?: string;
allow_credentials?: boolean;
}
export interface AppsCreateAppRequest {
spec: AppSpec;
project_id?: string;
}
export interface AppsCreateDeploymentRequest {
force_build?: boolean;
}
export interface AppsDedicatedEgressIp {
ip?: string;
id?: string;
status?: AppsDedicatedEgressIpStatus;
}
export declare const AppsDedicatedEgressIpStatus: {
readonly Unknown: "UNKNOWN";
readonly Assigning: "ASSIGNING";
readonly Assigned: "ASSIGNED";
readonly Removed: "REMOVED";
};
export type AppsDedicatedEgressIpStatus = (typeof AppsDedicatedEgressIpStatus)[keyof typeof AppsDedicatedEgressIpStatus];
export interface AppsDeleteAppResponse {
id?: string;
}
export interface AppsDeployment {
cause?: string;
cloned_from?: string;
created_at?: string;
id?: string;
jobs?: Array<AppsDeploymentJob>;
functions?: Array<AppsDeploymentFunctions>;
phase?: AppsDeploymentPhase;
phase_last_updated_at?: string;
progress?: AppsDeploymentProgress;
services?: Array<AppsDeploymentService>;
spec?: AppSpec;
static_sites?: Array<AppsDeploymentStaticSite>;
tier_slug?: string;
updated_at?: string;
workers?: Array<AppsDeploymentWorker>;
}
export interface AppsDeploymentFunctions {
name?: string;
source_commit_hash?: string;
namespace?: string;
}
export interface AppsDeploymentJob {
name?: string;
source_commit_hash?: string;
}
export declare const AppsDeploymentPhase: {
readonly Unknown: "UNKNOWN";
readonly PendingBuild: "PENDING_BUILD";
readonly Building: "BUILDING";
readonly PendingDeploy: "PENDING_DEPLOY";
readonly Deploying: "DEPLOYING";
readonly Active: "ACTIVE";
readonly Superseded: "SUPERSEDED";
readonly Error: "ERROR";
readonly Canceled: "CANCELED";
};
export type AppsDeploymentPhase = (typeof AppsDeploymentPhase)[keyof typeof AppsDeploymentPhase];
export interface AppsDeploymentProgress {
error_steps?: number;
pending_steps?: number;
running_steps?: number;
steps?: Array<AppsDeploymentProgressStep>;
success_steps?: number;
summary_steps?: Array<AppsDeploymentProgressStep>;
total_steps?: number;
}
export interface AppsDeploymentProgressStep {
component_name?: string;
ended_at?: string;
message_base?: string;
name?: string;
reason?: AppsDeploymentProgressStepReason;
started_at?: string;
status?: AppsDeploymentProgressStepStatus;
steps?: Array<object>;
}
export interface AppsDeploymentProgressStepReason {
code?: string;
message?: string;
}
export declare const AppsDeploymentProgressStepStatus: {
readonly Unknown: "UNKNOWN";
readonly Pending: "PENDING";
readonly Running: "RUNNING";
readonly Error: "ERROR";
readonly Success: "SUCCESS";
};
export type AppsDeploymentProgressStepStatus = (typeof AppsDeploymentProgressStepStatus)[keyof typeof AppsDeploymentProgressStepStatus];
export interface AppsDeploymentResponse {
deployment?: AppsDeployment;
}
export interface AppsDeploymentService {
name?: string;
source_commit_hash?: string;
}
export interface AppsDeploymentStaticSite {
name?: string;
source_commit_hash?: string;
}
export interface AppsDeploymentWorker {
name?: string;
source_commit_hash?: string;
}
export interface AppsDeploymentsResponse {
links?: PageLinks;
meta: MetaMeta;
deployments?: Array<AppsDeployment>;
}
export interface AppsDomain {
id?: string;
phase?: AppsDomainPhase;
progress?: AppsDomainProgress;
spec?: AppDomainSpec;
validations?: Array<AppDomainValidation>;
rotate_validation_records?: boolean;
certificate_expires_at?: string;
}
export declare const AppsDomainPhase: {
readonly Unknown: "UNKNOWN";
readonly Pending: "PENDING";
readonly Configuring: "CONFIGURING";
readonly Active: "ACTIVE";
readonly Error: "ERROR";
};
export type AppsDomainPhase = (typeof AppsDomainPhase)[keyof typeof AppsDomainPhase];
export interface AppsDomainProgress {
steps?: Array<object>;
}
export interface AppsGetInstanceSizeResponse {
instance_size?: AppsInstanceSize;
}
export interface AppsGetLogsResponse {
historic_urls?: Array<string>;
live_url?: string;
}
export interface AppsGitSourceSpec {
branch?: string;
repo_clone_url?: string;
}
export interface AppsGithubSourceSpec {
branch?: string;
deploy_on_push?: boolean;
repo?: string;
}
export interface AppsGitlabSourceSpec {
branch?: string;
deploy_on_push?: boolean;
repo?: string;
}
export interface AppsImageSourceSpec {
registry?: string;
registry_type?: AppsImageSourceSpecRegistryTypeEnum;
registry_credentials?: string;
repository?: string;
tag?: string;
digest?: string;
deploy_on_push?: AppsImageSourceSpecDeployOnPush;
}
export declare const AppsImageSourceSpecRegistryTypeEnum: {
readonly DockerHub: "DOCKER_HUB";
readonly Docr: "DOCR";
readonly Ghcr: "GHCR";
};
export type AppsImageSourceSpecRegistryTypeEnum = (typeof AppsImageSourceSpecRegistryTypeEnum)[keyof typeof AppsImageSourceSpecRegistryTypeEnum];
export interface AppsImageSourceSpecDeployOnPush {
enabled?: boolean;
}
export interface AppsInstanceSize {
bandwidth_allowance_gib?: string;
cpu_type?: InstanceSizeCpuType;
cpus?: string;
deprecation_intent?: boolean;
memory_bytes?: string;
name?: string;
scalable?: boolean;
single_instance_only?: boolean;
slug?: string;
tier_downgrade_to?: string;
tier_slug?: string;
tier_upgrade_to?: string;
usd_per_month?: string;
usd_per_second?: string;
}
export interface AppsListAlertsResponse {
alerts?: Array<AppAlert>;
}
export interface AppsListInstanceSizesResponse {
discount_percent?: number;
instance_sizes?: Array<AppsInstanceSize>;
}
export interface AppsListRegionsResponse {
regions?: Array<AppsRegion>;
}
export interface AppsRegion {
continent?: string;
data_centers?: Array<string>;
default?: boolean;
disabled?: boolean;
flag?: string;
label?: string;
reason?: string;
slug?: string;
}
export interface AppsResponse {
links?: PageLinks;
meta: MetaMeta;
apps?: Array<App>;
}
export interface AppsRollbackAppRequest {
deployment_id?: string;
skip_pin?: boolean;
}
export interface AppsStringMatch {
exact?: string;
prefix?: string;
regex?: string;
}
export interface AppsUpdateAppRequest {
spec: AppSpec;
update_all_source_versions?: boolean;
}
export interface AppsValidateRollback200Response {
valid?: boolean;
error?: AppsValidateRollback200ResponseError;
warnings?: Array<AppRollbackValidationCondition>;
}
export interface AppsValidateRollback200ResponseError {
code?: AppsValidateRollback200ResponseErrorCodeEnum;
message?: string;
components?: Array<string>;
}
export declare const AppsValidateRollback200ResponseErrorCodeEnum: {
readonly IncompatiblePhase: "incompatible_phase";
readonly IncompatibleResult: "incompatible_result";
readonly ExceededRevisionLimit: "exceeded_revision_limit";
readonly AppPinned: "app_pinned";
readonly DatabaseConfigConflict: "database_config_conflict";
readonly RegionConflict: "region_conflict";
readonly StaticSiteRequiresRebuild: "static_site_requires_rebuild";
readonly ImageSourceMissingDigest: "image_source_missing_digest";
};
export type AppsValidateRollback200ResponseErrorCodeEnum = (typeof AppsValidateRollback200ResponseErrorCodeEnum)[keyof typeof AppsValidateRollback200ResponseErrorCodeEnum];
export interface AssignDropletsByID {
id?: string;
name?: string;
project_id?: string;
ip?: string;
size_unit?: number;
size?: AssignDropletsByIDSizeEnum;
algorithm?: AssignDropletsByIDAlgorithmEnum;
status?: AssignDropletsByIDStatusEnum;
created_at?: string;
forwarding_rules: Array<ForwardingRule>;
health_check?: HealthCheck;
sticky_sessions?: StickySessions;
redirect_http_to_https?: boolean;
enable_proxy_protocol?: boolean;
enable_backend_keepalive?: boolean;
http_idle_timeout_seconds?: number;
vpc_uuid?: string;
disable_lets_encrypt_dns_records?: boolean;
firewall?: LbFirewall;
droplet_ids: Array<number>;
region: RegionSlug;
}
export declare const AssignDropletsByIDSizeEnum: {
readonly Small: "lb-small";
readonly Medium: "lb-medium";
readonly Large: "lb-large";
};
export type AssignDropletsByIDSizeEnum = (typeof AssignDropletsByIDSizeEnum)[keyof typeof AssignDropletsByIDSizeEnum];
export declare const AssignDropletsByIDAlgorithmEnum: {
readonly RoundRobin: "round_robin";
readonly LeastConnections: "least_connections";
};
export type AssignDropletsByIDAlgorithmEnum = (typeof AssignDropletsByIDAlgorithmEnum)[keyof typeof AssignDropletsByIDAlgorithmEnum];
export declare const AssignDropletsByIDStatusEnum: {
readonly New: "new";
readonly Active: "active";
readonly Errored: "errored";
};
export type AssignDropletsByIDStatusEnum = (typeof AssignDropletsByIDStatusEnum)[keyof typeof AssignDropletsByIDStatusEnum];
export interface AssignDropletsByTag {
id?: string;
name?: string;
project_id?: string;
ip?: string;
size_unit?: number;
size?: AssignDropletsByTagSizeEnum;
algorithm?: AssignDropletsByTagAlgorithmEnum;
status?: AssignDropletsByTagStatusEnum;
created_at?: string;
forwarding_rules: Array<ForwardingRule>;
health_check?: HealthCheck;
sticky_sessions?: StickySessions;
redirect_http_to_https?: boolean;
enable_proxy_protocol?: boolean;
enable_backend_keepalive?: boolean;
http_idle_timeout_seconds?: number;
vpc_uuid?: string;
disable_lets_encrypt_dns_records?: boolean;
firewall?: LbFirewall;
tag: string;
region: RegionSlug;
}
export declare const AssignDropletsByTagSizeEnum: {
readonly Small: "lb-small";
readonly Medium: "lb-medium";
readonly Large: "lb-large";
};
export type AssignDropletsByTagSizeEnum = (typeof AssignDropletsByTagSizeEnum)[keyof typeof AssignDropletsByTagSizeEnum];
export declare const AssignDropletsByTagAlgorithmEnum: {
readonly RoundRobin: "round_robin";
readonly LeastConnections: "least_connections";
};
export type AssignDropletsByTagAlgorithmEnum = (typeof AssignDropletsByTagAlgorithmEnum)[keyof typeof AssignDropletsByTagAlgorithmEnum];
export declare const AssignDropletsByTagStatusEnum: {
readonly New: "new";
readonly Active: "active";
readonly Errored: "errored";
};
export type AssignDropletsByTagStatusEnum = (typeof AssignDropletsByTagStatusEnum)[keyof typeof AssignDropletsByTagStatusEnum];
export interface AssignToDroplet {
droplet_id: number;
}
export interface AssignToDroplet1 {
droplet_id: number;
}
export interface AssociatedKubernetesResource {
id?: string;
name?: string;
}
export interface AssociatedKubernetesResources {
load_balancers?: Array<AssociatedKubernetesResource>;
volumes?: Array<AssociatedKubernetesResource>;
volume_snapshots?: Array<AssociatedKubernetesResource>;
}
export interface AssociatedResource {
id?: string;
name?: string;
cost?: string;
}
export interface AssociatedResourceStatus {
droplet?: DestroyedAssociatedResource;
resources?: AssociatedResourceStatusResources;
completed_at?: string;
failures?: number;
}
export interface AssociatedResourceStatusResources {
reserved_ips?: Array<DestroyedAssociatedResource>;
floating_ips?: Array<DestroyedAssociatedResource>;
snapshots?: Array<DestroyedAssociatedResource>;
volumes?: Array<DestroyedAssociatedResource>;
volume_snapshots?: Array<DestroyedAssociatedResource>;
}
export interface Backup {
created_at: string;
size_gigabytes: number;
}
export interface BackwardLinks {
first?: string;
prev?: string;
}
export interface Balance {
month_to_date_balance?: string;
account_balance?: string;
month_to_date_usage?: string;
generated_at?: string;
}
export interface BillingAddress {
address_line1?: string;
address_line2?: string;
city?: string;
region?: string;
postal_code?: string;
country_iso2_code?: string;
created_at?: string;
updated_at?: string;
}
export interface BillingHistory {
description?: string;
amount?: string;
invoice_id?: string;
invoice_uuid?: string;
date?: string;
type?: BillingHistoryTypeEnum;
}
export declare const BillingHistoryTypeEnum: {
readonly AchFailure: "ACHFailure";
readonly Adjustment: "Adjustment";
readonly AttemptFailed: "AttemptFailed";
readonly Chargeback: "Chargeback";
readonly Credit: "Credit";
readonly CreditExpiration: "CreditExpiration";
readonly Invoice: "Invoice";
readonly Payment: "Payment";
readonly Refund: "Refund";
readonly Reversal: "Reversal";
};
export type BillingHistoryTypeEnum = (typeof BillingHistoryTypeEnum)[keyof typeof BillingHistoryTypeEnum];
export interface BillingHistoryList200Response {
links?: PageLinks;
meta: MetaProperties;
billing_history?: Array<BillingHistory>;
}
export interface Ca {
certificate: string;
}
export interface CdnCreateEndpoint201Response {
endpoint?: CdnEndpoint;
}
export interface CdnEndpoint {
id?: string;
origin: string;
endpoint?: string;
ttl?: CdnEndpointTtlEnum;
certificate_id?: string;
custom_domain?: string;
created_at?: string;
}
export declare const CdnEndpointTtlEnum: {
readonly NUMBER_60: 60;
readonly NUMBER_600: 600;
readonly NUMBER_3600: 3600;
readonly NUMBER_86400: 86400;
readonly NUMBER_604800: 604800;
};
export type CdnEndpointTtlEnum = (typeof CdnEndpointTtlEnum)[keyof typeof CdnEndpointTtlEnum];
export interface CdnListEndpoints200Response {
links?: PageLinks;
meta: MetaMeta;
endpoints?: Array<CdnEndpoint>;
}
export interface Certificate {
id?: string;
name?: string;
not_after?: string;
sha1_fingerprint?: string;
created_at?: string;
dns_names?: Array<string>;
state?: CertificateStateEnum;
type?: CertificateTypeEnum;
}
export declare const CertificateStateEnum: {
readonly Pending: "pending";
readonly Verified: "verified";
readonly Error: "error";
};
export type CertificateStateEnum = (typeof CertificateStateEnum)[keyof typeof CertificateStateEnum];
export declare const CertificateTypeEnum: {
readonly Custom: "custom";
readonly LetsEncrypt: "lets_encrypt";
};
export type CertificateTypeEnum = (typeof CertificateTypeEnum)[keyof typeof CertificateTypeEnum];
export interface CertificateCreateBase {
name: string;
type?: CertificateCreateBaseTypeEnum;
}
export declare const CertificateCreateBaseTypeEnum: {
readonly Custom: "custom";
readonly LetsEncrypt: "lets_encrypt";
};
export type CertificateCreateBaseTypeEnum = (typeof CertificateCreateBaseTypeEnum)[keyof typeof CertificateCreateBaseTypeEnum];
export interface CertificateRequestCustom {
name: string;
type?: CertificateRequestCustomTypeEnum;
private_key: string;
leaf_certificate: string;
certificate_chain?: string;
}
export declare const CertificateRequestCustomTypeEnum: {
readonly Custom: "custom";
readonly LetsEncrypt: "lets_encrypt";
};
export type CertificateRequestCustomTypeEnum = (typeof CertificateRequestCustomTypeEnum)[keyof typeof CertificateRequestCustomTypeEnum];
export interface CertificateRequestLetsEncrypt {
name: string;
type?: CertificateRequestLetsEncryptTypeEnum;
dns_names: Array<string>;
}
export declare const CertificateRequestLetsEncryptTypeEnum: {
readonly Custom: "custom";
readonly LetsEncrypt: "lets_encrypt";
};
export type CertificateRequestLetsEncryptTypeEnum = (typeof CertificateRequestLetsEncryptTypeEnum)[keyof typeof CertificateRequestLetsEncryptTypeEnum];
export interface CertificatesCreate201Response {
certificate?: Certificate;
}
export type CertificatesCreateRequest = CertificateRequestCustom | CertificateRequestLetsEncrypt;
export interface CertificatesList200Response {
links?: PageLinks;
meta: MetaMeta;
certificates?: Array<Certificate>;
}
export interface Check {
id?: string;
name?: string;
type?: CheckTypeEnum;
target?: string;
regions?: Array<CheckRegionsEnum>;
enabled?: boolean;
}
export declare const CheckTypeEnum: {
readonly Ping: "ping";
readonly Http: "http";
readonly Https: "https";
};
export type CheckTypeEnum = (typeof CheckTypeEnum)[keyof typeof CheckTypeEnum];
export declare const CheckRegionsEnum: {
readonly UsEast: "us_east";
readonly UsWest: "us_west";
readonly EuWest: "eu_west";
readonly SeAsia: "se_asia";
};
export type CheckRegionsEnum = (typeof CheckRegionsEnum)[keyof typeof CheckRegionsEnum];
export interface CheckBase {
id?: string;
}
export interface CheckUpdatable {
name?: string;
type?: CheckUpdatableTypeEnum;
target?: string;
regions?: Array<CheckUpdatableRegionsEnum>;
enabled?: boolean;
}
export declare const CheckUpdatableTypeEnum: {
readonly Ping: "ping";
readonly Http: "http";
readonly Https: "https";
};
export type CheckUpdatableTypeEnum = (typeof CheckUpdatableTypeEnum)[keyof typeof CheckUpdatableTypeEnum];
export declare const CheckUpdatableRegionsEnum: {
readonly UsEast: "us_east";
readonly UsWest: "us_west";
readonly EuWest: "eu_west";
readonly SeAsia: "se_asia";
};
export type CheckUpdatableRegionsEnum = (typeof CheckUpdatableRegionsEnum)[keyof typeof CheckUpdatableRegionsEnum];
export interface Cluster {
id?: string;
name: string;
region: string;
version: string;
cluster_subnet?: string;
service_subnet?: string;
vpc_uuid?: string;
ipv4?: string;
endpoint?: string;
tags?: Array<string>;
node_pools: Array<KubernetesNodePool>;
maintenance_policy?: MaintenancePolicy | null;
auto_upgrade?: boolean;
status?: ClusterStatus;
created_at?: string;
updated_at?: string;
surge_upgrade?: boolean;
ha?: boolean;
registry_enabled?: boolean;
control_plane_firewall?: ControlPlaneFirewall | null;
}
export interface ClusterRegistries {
cluster_uuids?: Array<string>;
}
export interface ClusterStatus {
state?: ClusterStatusStateEnum;
message?: string;
}
export declare const ClusterStatusStateEnum: {
readonly Running: "running";
readonly Provisioning: "provisioning";
read