@northflank/js-client 0.7.17 → 0.7.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -267,7 +267,7 @@ type ListAddonsResult = {
267
267
  'type': string;
268
268
  };
269
269
  /** The current state of the addon. Example: "running" */
270
- 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
270
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
271
271
  }[];
272
272
  };
273
273
  type ListAddonsCall = (opts: ListAddonsRequest) => Promise<ApiCallResponse<ListAddonsResult>>;
@@ -496,6 +496,7 @@ declare class NorthflankExecCommand {
496
496
  type LogsRequestCommon = LogRequestTextFilters & {
497
497
  lineLimit?: number;
498
498
  startTime?: Date;
499
+ deploymentId?: string;
499
500
  };
500
501
  type JobLogsRangeRequestData = LogsRequestCommon & {
501
502
  direction?: 'forward' | 'backward';
@@ -939,6 +940,7 @@ type MetricsEntry = {
939
940
  };
940
941
  type MetricsRequestCommon = {
941
942
  metricTypes?: MetricType[];
943
+ deploymentId?: string;
942
944
  };
943
945
  type JobMetricsRangeRequestData = MetricsRequestCommon & {
944
946
  startTime?: Date;
@@ -1159,10 +1161,6 @@ type GetAddonTypesResult = {
1159
1161
  'name': string;
1160
1162
  /** A description of the addon. Example: "Redis implements a distributed, in-memory key-value database with optional durability." */
1161
1163
  'description': string;
1162
- /** A list of available versions of the addon type. */
1163
- 'versions': string[];
1164
- /** A list of available major versions of the addon type. */
1165
- 'major': string[];
1166
1164
  /** Features supported by this addon type. */
1167
1165
  'features'?: {
1168
1166
  /** Whether this addon supports native (dump) backups */
@@ -1182,6 +1180,10 @@ type GetAddonTypesResult = {
1182
1180
  /** Whether this addon supports external connection. Example: true */
1183
1181
  'externalAccess': boolean;
1184
1182
  };
1183
+ /** A list of available versions of the addon type. */
1184
+ 'versions': string[];
1185
+ /** A list of available major versions of the addon type. */
1186
+ 'major': string[];
1185
1187
  /** Details about resource options for the addon type. */
1186
1188
  'resources': {
1187
1189
  /** Details about storage size options for this addon. */
@@ -1199,6 +1201,50 @@ type GetAddonTypesResult = {
1199
1201
  'default': number;
1200
1202
  };
1201
1203
  };
1204
+ }[] | {
1205
+ /** The identifier for the addon type. Example: "redis" */
1206
+ 'type': string;
1207
+ /** The name of the addon type. Example: "Redis" */
1208
+ 'name': string;
1209
+ /** A description of the addon. Example: "Redis implements a distributed, in-memory key-value database with optional durability." */
1210
+ 'description': string;
1211
+ /** Features supported by this addon type. */
1212
+ 'features'?: {
1213
+ /** Whether this addon supports native (dump) backups */
1214
+ 'backupsDump': boolean;
1215
+ /** Whether this addon supports customising the database name. */
1216
+ 'customDBName': boolean;
1217
+ /** Whether this addon supports addon forking - creating a new addon from an existing addon backup. */
1218
+ 'forkAddon': boolean;
1219
+ /** Whether this addon supports importing from an external backup. */
1220
+ 'importDump': boolean;
1221
+ /** Whether this addon supports importing from an existing live database. */
1222
+ 'importLive': boolean;
1223
+ /** Whether this addon supports replica scaling. */
1224
+ 'scaleReplicas': boolean;
1225
+ /** Whether this addon supports connection via TLS. Example: true */
1226
+ 'tls': boolean;
1227
+ /** Whether this addon supports external connection. Example: true */
1228
+ 'externalAccess': boolean;
1229
+ };
1230
+ 'config': {
1231
+ /** Allow addon user to view values provided to templating engine. */
1232
+ 'showTemplateValues'?: boolean;
1233
+ /** Allow addon user to edit values provided to templating engine. */
1234
+ 'enableTemplateValuesModification'?: boolean;
1235
+ /** Allow addon user to view and resolve potential errors occuring with templating engine run. */
1236
+ 'enableErrorRecovery'?: boolean;
1237
+ /** Install CRDs provided in resource bundle. */
1238
+ 'installCrds'?: boolean;
1239
+ /** Apply Northflank specific labels and annotations to Kubernetes resources. Required for core features such as viewing containers, logs, metrics. */
1240
+ 'useNfLabelsAndAnnotations'?: boolean;
1241
+ /** Apply Northflank secret injection instead of using Kubernetes secrets. */
1242
+ 'useNfSecretInjection'?: boolean;
1243
+ /** Inject Northflank-specific Kubernetes imagePullSecret to Pod resources. */
1244
+ 'useNfImagePullSecret'?: boolean;
1245
+ };
1246
+ /** If the addon deploys any k8s resources which are not namespace/project-scoped, it's a cluster scoped addon */
1247
+ 'scope': 'project' | 'cluster';
1202
1248
  }[];
1203
1249
  };
1204
1250
  type GetAddonTypesCall = (opts: GetAddonTypesRequest) => Promise<ApiCallResponse<GetAddonTypesResult>>;
@@ -1754,6 +1800,8 @@ type CreateCloudClusterResult = {
1754
1800
  };
1755
1801
  'nextUpdateAfter'?: string;
1756
1802
  };
1803
+ /** Auto-generated dns identifier for this cluster. Example: "xxxxxxxxxx" */
1804
+ 'dns'?: string;
1757
1805
  /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
1758
1806
  'createdAt': string;
1759
1807
  /** Indicates if provider resource deletion has been requested. */
@@ -2082,6 +2130,8 @@ type GetCloudClusterResult = {
2082
2130
  };
2083
2131
  'nextUpdateAfter'?: string;
2084
2132
  };
2133
+ /** Auto-generated dns identifier for this cluster. Example: "xxxxxxxxxx" */
2134
+ 'dns'?: string;
2085
2135
  /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
2086
2136
  'createdAt': string;
2087
2137
  /** Indicates if provider resource deletion has been requested. */
@@ -2261,6 +2311,8 @@ type UpdateCloudClusterResult = {
2261
2311
  };
2262
2312
  'nextUpdateAfter'?: string;
2263
2313
  };
2314
+ /** Auto-generated dns identifier for this cluster. Example: "xxxxxxxxxx" */
2315
+ 'dns'?: string;
2264
2316
  /** The time the cluster was created. Example: "2021-01-20T11:19:53.175Z" */
2265
2317
  'createdAt': string;
2266
2318
  /** Indicates if provider resource deletion has been requested. */
@@ -3216,6 +3268,66 @@ type GetSubdomainResult = {
3216
3268
  'content': string;
3217
3269
  /** Whether the subdomain has been verified successfully and can be used. Example: true */
3218
3270
  'verified': boolean;
3271
+ 'certificate'?: {
3272
+ /** Whether a certificate is in the process of being generated */
3273
+ 'inProgress'?: boolean;
3274
+ /** Expiry date of the current certificate */
3275
+ 'expiryDate'?: string;
3276
+ /** Refresh date of the current certificate */
3277
+ 'refreshDare'?: string;
3278
+ };
3279
+ 'cdn'?: {
3280
+ 'cloudfront'?: {
3281
+ 'enabled'?: boolean;
3282
+ 'status'?: string;
3283
+ 'deployedAt'?: string;
3284
+ };
3285
+ 'fastly'?: {
3286
+ 'enabled'?: boolean;
3287
+ 'status'?: string;
3288
+ 'options'?: {
3289
+ 'service'?: {
3290
+ 'forceTlsEnableHsts'?: boolean;
3291
+ /** HSTS duration. Required when `forceTlsEnableHsts` is `true`. */
3292
+ 'hstsDuration'?: number;
3293
+ 'staleIfError'?: boolean;
3294
+ 'staleIfErrorTtl'?: number;
3295
+ 'defaultTtl'?: number;
3296
+ };
3297
+ 'logging'?: {
3298
+ 'enabled'?: boolean;
3299
+ };
3300
+ 'http3'?: {
3301
+ 'enabled'?: boolean;
3302
+ };
3303
+ 'websockets'?: {
3304
+ 'enabled'?: boolean;
3305
+ };
3306
+ 'compression'?: {
3307
+ 'enabled'?: boolean;
3308
+ /** Compression options. Required when `enabled` is `true`. */
3309
+ 'mode'?: 'gzip' | 'brotli';
3310
+ };
3311
+ 'vclSnippets'?: {
3312
+ 'id'?: string;
3313
+ 'name': string;
3314
+ 'type': 'init' | 'recv' | 'hash' | 'hit' | 'miss' | 'pass' | 'fetch' | 'error' | 'deliver' | 'log' | 'none';
3315
+ 'dynamic': '0' | '1';
3316
+ 'priority': number;
3317
+ 'content': string;
3318
+ }[];
3319
+ 'cacheSettings'?: {
3320
+ 'id'?: string;
3321
+ 'name': string;
3322
+ 'action'?: 'pass' | 'cache' | 'restart';
3323
+ 'cacheCondition'?: string;
3324
+ 'staleTtl': number;
3325
+ 'ttl': number;
3326
+ }[];
3327
+ };
3328
+ 'deployedAt'?: string;
3329
+ };
3330
+ };
3219
3331
  };
3220
3332
  type GetSubdomainCall = (opts: GetSubdomainRequest) => Promise<ApiCallResponse<GetSubdomainResult>>;
3221
3333
  type GetSubdomainRequest = {
@@ -3533,17 +3645,17 @@ declare class AddSubdomainPathEndpoint extends PostApiEndpoint<AddSubdomainPathR
3533
3645
  type ListSubdomainPathResult = {
3534
3646
  /** A list of paths created for the given subdomain. */
3535
3647
  'paths': {
3536
- /** The domain the path should be created for. */
3648
+ /** The domain the path should be created for. Example: "site.example.com" */
3537
3649
  'subdomain': string;
3538
- /** Mode of the path, determining how the URI will be interpreted. */
3539
- 'mode': 'prefix' | 'exact' | 'regex' | string;
3540
- /** URI of the subdomain path. Interpreted according to the selected path mode */
3650
+ /** Mode of the path, determining how the URI will be interpreted. Example: "prefix" */
3651
+ 'mode': 'prefix' | 'exact' | 'regex';
3652
+ /** URI of the subdomain path. Interpreted according to the selected path mode Example: "/" */
3541
3653
  'uri': string;
3542
3654
  'options'?: {
3543
3655
  /** In case of uri conflicts, the route with the higher priority will take precedence */
3544
- 'priority'?: number | string;
3656
+ 'priority'?: number;
3545
3657
  /** Allows case insensitive matching for 'prefix' and 'exact' modes */
3546
- 'ignoreUriCase'?: boolean | string;
3658
+ 'ignoreUriCase'?: boolean;
3547
3659
  /** Settings determining if a path should be rewritten. Either a uri or regex have to be specified. */
3548
3660
  'rewrite'?: {
3549
3661
  'uri': string;
@@ -4126,7 +4238,23 @@ type CreateLogsinkData = {
4126
4238
  /** Codec to encode logs in Example: "json" */
4127
4239
  'codec': 'text' | 'json';
4128
4240
  };
4129
- 'auth': any;
4241
+ /** Auth information. */
4242
+ 'auth': {
4243
+ /** No authentication strategy Example: "none" */
4244
+ 'strategy': 'none';
4245
+ } | {
4246
+ /** Basic HTTP authentication strategy. Example: "basic" */
4247
+ 'strategy': 'basic';
4248
+ /** Username for basic http authentication. Example: "my-user" */
4249
+ 'user'?: string;
4250
+ /** Password for basic http authentication. Example: "secret-password" */
4251
+ 'password': string;
4252
+ } | {
4253
+ /** Bearer token authentication strategy. Example: "bearer" */
4254
+ 'strategy': 'bearer';
4255
+ /** Token for bearer token authentication. Example: "my-token" */
4256
+ 'token'?: string;
4257
+ };
4130
4258
  };
4131
4259
  } | {
4132
4260
  /** Name of the log sink. Example: "example-log-sink" */
@@ -4361,15 +4489,6 @@ type GetLogsinkResult = {
4361
4489
  /** The Datadog region. Example: "eu" */
4362
4490
  'region': 'eu' | 'us' | 'us3' | 'us5';
4363
4491
  } | any | {
4364
- /** Uri to send logs to. Example: "my.log-collector.com" */
4365
- 'uri': string;
4366
- /** Encoding options */
4367
- 'encoding'?: {
4368
- /** Codec to encode logs in Example: "json" */
4369
- 'codec': 'text' | 'json';
4370
- };
4371
- 'auth': any;
4372
- } | {
4373
4492
  /** Endpoint for the AWS S3 or compatible API bucket. Example: "my.bucket.com" */
4374
4493
  'endpoint': string;
4375
4494
  /** Region of the S3 bucket. Example: "eu-west-2" */
@@ -4386,16 +4505,46 @@ type GetLogsinkResult = {
4386
4505
  /** Log file compression method. Example: "gzip" */
4387
4506
  'compression': 'gzip' | 'none';
4388
4507
  } | {
4389
- /** Better Stack Source Token Example: "vhnqrLygVQ5GnSQUTZamKvAq" */
4390
- 'token': string;
4508
+ /** Uri to send logs to. Example: "my.log-collector.com" */
4509
+ 'uri': string;
4510
+ /** Encoding options */
4511
+ 'encoding'?: {
4512
+ /** Codec to encode logs in Example: "json" */
4513
+ 'codec': 'text' | 'json';
4514
+ };
4515
+ /** Auth information. */
4516
+ 'auth': {
4517
+ /** No authentication strategy Example: "none" */
4518
+ 'strategy': 'none';
4519
+ } | {
4520
+ /** Basic HTTP authentication strategy. Example: "basic" */
4521
+ 'strategy': 'basic';
4522
+ /** Username for basic http authentication. Example: "my-user" */
4523
+ 'user'?: string;
4524
+ /** Password for basic http authentication. Example: "secret-password" */
4525
+ 'password': string;
4526
+ } | {
4527
+ /** Bearer token authentication strategy. Example: "bearer" */
4528
+ 'strategy': 'bearer';
4529
+ /** Token for bearer token authentication. Example: "my-token" */
4530
+ 'token'?: string;
4531
+ };
4391
4532
  } | {
4392
4533
  /** Ingestion Key Example: "b1dd3feb585asd1a3e9edpo9kmn5e590hg9" */
4393
4534
  'api_key': string;
4535
+ } | {
4536
+ /** Better Stack Source Token Example: "vhnqrLygVQ5GnSQUTZamKvAq" */
4537
+ 'token': string;
4394
4538
  } | {
4395
4539
  /** Honeycomb API Key Example: "b1dd3feb585asd1a3e9" */
4396
4540
  'api_key': string;
4397
4541
  /** Name of the dataset Example: "staging-logs" */
4398
4542
  'dataset': string;
4543
+ } | {
4544
+ /** Your Logzio region code Example: "eu" */
4545
+ 'region': 'eu' | 'uk' | 'us' | 'ca' | 'au' | 'nl' | 'wa';
4546
+ /** The Log Shipping Token of the account you want to ship to Example: "sNFijNFgNFoNFrMsNFbNFObNFcgNFqoa" */
4547
+ 'token': string;
4399
4548
  } | {
4400
4549
  /** Name of the data Example: "staging" */
4401
4550
  'dataset': string;
@@ -4407,6 +4556,11 @@ type GetLogsinkResult = {
4407
4556
  'orgId'?: string;
4408
4557
  /** The Axiom url to use. Only change if self hosting axiom. */
4409
4558
  'url': string;
4559
+ } | {
4560
+ /** New Relic Account ID Example: "b1dd3feb585asd1a3e9" */
4561
+ 'accountId': string;
4562
+ /** New Relic License Key Example: "b1dd3feb585asd1a3e9" */
4563
+ 'licenseKey': string;
4410
4564
  };
4411
4565
  };
4412
4566
  type GetLogsinkCall = (opts: GetLogsinkRequest) => Promise<ApiCallResponse<GetLogsinkResult>>;
@@ -4526,7 +4680,23 @@ type UpdateLogsinkData = {
4526
4680
  /** Codec to encode logs in Example: "json" */
4527
4681
  'codec': 'text' | 'json';
4528
4682
  };
4529
- 'auth': any;
4683
+ /** Auth information. */
4684
+ 'auth': {
4685
+ /** No authentication strategy Example: "none" */
4686
+ 'strategy': 'none';
4687
+ } | {
4688
+ /** Basic HTTP authentication strategy. Example: "basic" */
4689
+ 'strategy': 'basic';
4690
+ /** Username for basic http authentication. Example: "my-user" */
4691
+ 'user'?: string;
4692
+ /** Password for basic http authentication. Example: "secret-password" */
4693
+ 'password': string;
4694
+ } | {
4695
+ /** Bearer token authentication strategy. Example: "bearer" */
4696
+ 'strategy': 'bearer';
4697
+ /** Token for bearer token authentication. Example: "my-token" */
4698
+ 'token'?: string;
4699
+ };
4530
4700
  } | {
4531
4701
  /** Endpoint for the AWS S3 or compatible API bucket. Example: "my.bucket.com" */
4532
4702
  'endpoint': string;
@@ -5506,9 +5676,9 @@ type CreateProjectResult = {
5506
5676
  /** Whether or not to inject a Tailscale sidecar for this project's resources */
5507
5677
  'enabled'?: boolean;
5508
5678
  'restrictions'?: {
5509
- /** Whether or not to restrict the Tailscale sidecar to run only on resources with specific tags */
5679
+ /** Whether or not to restrict the settings to resources with specific tags */
5510
5680
  'enabled': boolean;
5511
- /** The tags which determine whether Tailscale sidecar should be added */
5681
+ /** The tags which determine the resources the settings should be applied to */
5512
5682
  'tags'?: string[];
5513
5683
  };
5514
5684
  'options'?: {
@@ -5521,6 +5691,22 @@ type CreateProjectResult = {
5521
5691
  'authKey'?: string;
5522
5692
  };
5523
5693
  };
5694
+ /** Defines the project host alias overrides to apply to /etc/hosts in resource containers */
5695
+ 'hostAliases'?: {
5696
+ /** Enable support for adding /etc/hosts overrides for a container */
5697
+ 'enabled'?: boolean;
5698
+ /** Entries to add to /etc/hosts */
5699
+ 'hostEntries'?: {
5700
+ 'ipAddress': string;
5701
+ 'hostnames': string[];
5702
+ }[];
5703
+ 'restrictions'?: {
5704
+ /** Whether or not to restrict the settings to resources with specific tags */
5705
+ 'enabled': boolean;
5706
+ /** The tags which determine the resources the settings should be applied to */
5707
+ 'tags'?: string[];
5708
+ };
5709
+ };
5524
5710
  };
5525
5711
  /** time of creation Example: "2000-01-01T12:00:00.000Z" */
5526
5712
  'createdAt'?: string;
@@ -5540,6 +5726,47 @@ type CreateProjectData = {
5540
5726
  'color'?: string;
5541
5727
  /** The region the project will be hosted in. Example: "europe-west" */
5542
5728
  'region'?: string;
5729
+ /** Advanced project networking settings. */
5730
+ 'networking'?: {
5731
+ /** Projects from which ingress request should be permitted. */
5732
+ 'allowedIngressProjects'?: string[];
5733
+ /** Defines this project's Tailscale sidecar settings */
5734
+ 'tailscale'?: {
5735
+ /** Whether or not to inject a Tailscale sidecar for this project's resources */
5736
+ 'enabled'?: boolean;
5737
+ 'restrictions'?: {
5738
+ /** Whether or not to restrict the settings to resources with specific tags */
5739
+ 'enabled': boolean;
5740
+ /** The tags which determine the resources the settings should be applied to */
5741
+ 'tags'?: string[];
5742
+ };
5743
+ 'options'?: {
5744
+ 'cpuLimit'?: string;
5745
+ 'memoryLimit'?: string;
5746
+ };
5747
+ /** Relevant Tailscale secrets */
5748
+ 'secrets'?: {
5749
+ /** Tailscale auth key (required for enabling Tailscale) */
5750
+ 'authKey'?: string;
5751
+ };
5752
+ };
5753
+ /** Defines the project host alias overrides to apply to /etc/hosts in resource containers */
5754
+ 'hostAliases'?: {
5755
+ /** Enable support for adding /etc/hosts overrides for a container */
5756
+ 'enabled'?: boolean;
5757
+ /** Entries to add to /etc/hosts */
5758
+ 'hostEntries'?: {
5759
+ 'ipAddress': string;
5760
+ 'hostnames': string[];
5761
+ }[];
5762
+ 'restrictions'?: {
5763
+ /** Whether or not to restrict the settings to resources with specific tags */
5764
+ 'enabled': boolean;
5765
+ /** The tags which determine the resources the settings should be applied to */
5766
+ 'tags'?: string[];
5767
+ };
5768
+ };
5769
+ };
5543
5770
  } | {
5544
5771
  /** The name of the project. Example: "New Project" */
5545
5772
  'name': string;
@@ -5549,6 +5776,47 @@ type CreateProjectData = {
5549
5776
  'color'?: string;
5550
5777
  /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
5551
5778
  'clusterId'?: string;
5779
+ /** Advanced project networking settings. */
5780
+ 'networking'?: {
5781
+ /** Projects from which ingress request should be permitted. */
5782
+ 'allowedIngressProjects'?: string[];
5783
+ /** Defines this project's Tailscale sidecar settings */
5784
+ 'tailscale'?: {
5785
+ /** Whether or not to inject a Tailscale sidecar for this project's resources */
5786
+ 'enabled'?: boolean;
5787
+ 'restrictions'?: {
5788
+ /** Whether or not to restrict the settings to resources with specific tags */
5789
+ 'enabled': boolean;
5790
+ /** The tags which determine the resources the settings should be applied to */
5791
+ 'tags'?: string[];
5792
+ };
5793
+ 'options'?: {
5794
+ 'cpuLimit'?: string;
5795
+ 'memoryLimit'?: string;
5796
+ };
5797
+ /** Relevant Tailscale secrets */
5798
+ 'secrets'?: {
5799
+ /** Tailscale auth key (required for enabling Tailscale) */
5800
+ 'authKey'?: string;
5801
+ };
5802
+ };
5803
+ /** Defines the project host alias overrides to apply to /etc/hosts in resource containers */
5804
+ 'hostAliases'?: {
5805
+ /** Enable support for adding /etc/hosts overrides for a container */
5806
+ 'enabled'?: boolean;
5807
+ /** Entries to add to /etc/hosts */
5808
+ 'hostEntries'?: {
5809
+ 'ipAddress': string;
5810
+ 'hostnames': string[];
5811
+ }[];
5812
+ 'restrictions'?: {
5813
+ /** Whether or not to restrict the settings to resources with specific tags */
5814
+ 'enabled': boolean;
5815
+ /** The tags which determine the resources the settings should be applied to */
5816
+ 'tags'?: string[];
5817
+ };
5818
+ };
5819
+ };
5552
5820
  };
5553
5821
  /** Creates a new project. */
5554
5822
  declare class CreateProjectEndpoint extends PostApiEndpoint<CreateProjectRequest, CreateProjectResult> {
@@ -5581,9 +5849,9 @@ type PutProjectResult = {
5581
5849
  /** Whether or not to inject a Tailscale sidecar for this project's resources */
5582
5850
  'enabled'?: boolean;
5583
5851
  'restrictions'?: {
5584
- /** Whether or not to restrict the Tailscale sidecar to run only on resources with specific tags */
5852
+ /** Whether or not to restrict the settings to resources with specific tags */
5585
5853
  'enabled': boolean;
5586
- /** The tags which determine whether Tailscale sidecar should be added */
5854
+ /** The tags which determine the resources the settings should be applied to */
5587
5855
  'tags'?: string[];
5588
5856
  };
5589
5857
  'options'?: {
@@ -5596,6 +5864,22 @@ type PutProjectResult = {
5596
5864
  'authKey'?: string;
5597
5865
  };
5598
5866
  };
5867
+ /** Defines the project host alias overrides to apply to /etc/hosts in resource containers */
5868
+ 'hostAliases'?: {
5869
+ /** Enable support for adding /etc/hosts overrides for a container */
5870
+ 'enabled'?: boolean;
5871
+ /** Entries to add to /etc/hosts */
5872
+ 'hostEntries'?: {
5873
+ 'ipAddress': string;
5874
+ 'hostnames': string[];
5875
+ }[];
5876
+ 'restrictions'?: {
5877
+ /** Whether or not to restrict the settings to resources with specific tags */
5878
+ 'enabled': boolean;
5879
+ /** The tags which determine the resources the settings should be applied to */
5880
+ 'tags'?: string[];
5881
+ };
5882
+ };
5599
5883
  };
5600
5884
  /** time of creation Example: "2000-01-01T12:00:00.000Z" */
5601
5885
  'createdAt'?: string;
@@ -5615,6 +5899,47 @@ type PutProjectData = {
5615
5899
  'color'?: string;
5616
5900
  /** The region the project will be hosted in. Example: "europe-west" */
5617
5901
  'region'?: string;
5902
+ /** Advanced project networking settings. */
5903
+ 'networking'?: {
5904
+ /** Projects from which ingress request should be permitted. */
5905
+ 'allowedIngressProjects'?: string[];
5906
+ /** Defines this project's Tailscale sidecar settings */
5907
+ 'tailscale'?: {
5908
+ /** Whether or not to inject a Tailscale sidecar for this project's resources */
5909
+ 'enabled'?: boolean;
5910
+ 'restrictions'?: {
5911
+ /** Whether or not to restrict the settings to resources with specific tags */
5912
+ 'enabled': boolean;
5913
+ /** The tags which determine the resources the settings should be applied to */
5914
+ 'tags'?: string[];
5915
+ };
5916
+ 'options'?: {
5917
+ 'cpuLimit'?: string;
5918
+ 'memoryLimit'?: string;
5919
+ };
5920
+ /** Relevant Tailscale secrets */
5921
+ 'secrets'?: {
5922
+ /** Tailscale auth key (required for enabling Tailscale) */
5923
+ 'authKey'?: string;
5924
+ };
5925
+ };
5926
+ /** Defines the project host alias overrides to apply to /etc/hosts in resource containers */
5927
+ 'hostAliases'?: {
5928
+ /** Enable support for adding /etc/hosts overrides for a container */
5929
+ 'enabled'?: boolean;
5930
+ /** Entries to add to /etc/hosts */
5931
+ 'hostEntries'?: {
5932
+ 'ipAddress': string;
5933
+ 'hostnames': string[];
5934
+ }[];
5935
+ 'restrictions'?: {
5936
+ /** Whether or not to restrict the settings to resources with specific tags */
5937
+ 'enabled': boolean;
5938
+ /** The tags which determine the resources the settings should be applied to */
5939
+ 'tags'?: string[];
5940
+ };
5941
+ };
5942
+ };
5618
5943
  } | {
5619
5944
  /** The name of the project. Example: "New Project" */
5620
5945
  'name': string;
@@ -5624,6 +5949,47 @@ type PutProjectData = {
5624
5949
  'color'?: string;
5625
5950
  /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
5626
5951
  'clusterId'?: string;
5952
+ /** Advanced project networking settings. */
5953
+ 'networking'?: {
5954
+ /** Projects from which ingress request should be permitted. */
5955
+ 'allowedIngressProjects'?: string[];
5956
+ /** Defines this project's Tailscale sidecar settings */
5957
+ 'tailscale'?: {
5958
+ /** Whether or not to inject a Tailscale sidecar for this project's resources */
5959
+ 'enabled'?: boolean;
5960
+ 'restrictions'?: {
5961
+ /** Whether or not to restrict the settings to resources with specific tags */
5962
+ 'enabled': boolean;
5963
+ /** The tags which determine the resources the settings should be applied to */
5964
+ 'tags'?: string[];
5965
+ };
5966
+ 'options'?: {
5967
+ 'cpuLimit'?: string;
5968
+ 'memoryLimit'?: string;
5969
+ };
5970
+ /** Relevant Tailscale secrets */
5971
+ 'secrets'?: {
5972
+ /** Tailscale auth key (required for enabling Tailscale) */
5973
+ 'authKey'?: string;
5974
+ };
5975
+ };
5976
+ /** Defines the project host alias overrides to apply to /etc/hosts in resource containers */
5977
+ 'hostAliases'?: {
5978
+ /** Enable support for adding /etc/hosts overrides for a container */
5979
+ 'enabled'?: boolean;
5980
+ /** Entries to add to /etc/hosts */
5981
+ 'hostEntries'?: {
5982
+ 'ipAddress': string;
5983
+ 'hostnames': string[];
5984
+ }[];
5985
+ 'restrictions'?: {
5986
+ /** Whether or not to restrict the settings to resources with specific tags */
5987
+ 'enabled': boolean;
5988
+ /** The tags which determine the resources the settings should be applied to */
5989
+ 'tags'?: string[];
5990
+ };
5991
+ };
5992
+ };
5627
5993
  };
5628
5994
  /** Creates or updates a project. */
5629
5995
  declare class PutProjectEndpoint extends PutApiEndpoint<PutProjectRequest, PutProjectResult> {
@@ -5656,9 +6022,9 @@ type PatchProjectResult = {
5656
6022
  /** Whether or not to inject a Tailscale sidecar for this project's resources */
5657
6023
  'enabled'?: boolean;
5658
6024
  'restrictions'?: {
5659
- /** Whether or not to restrict the Tailscale sidecar to run only on resources with specific tags */
6025
+ /** Whether or not to restrict the settings to resources with specific tags */
5660
6026
  'enabled': boolean;
5661
- /** The tags which determine whether Tailscale sidecar should be added */
6027
+ /** The tags which determine the resources the settings should be applied to */
5662
6028
  'tags'?: string[];
5663
6029
  };
5664
6030
  'options'?: {
@@ -5671,6 +6037,22 @@ type PatchProjectResult = {
5671
6037
  'authKey'?: string;
5672
6038
  };
5673
6039
  };
6040
+ /** Defines the project host alias overrides to apply to /etc/hosts in resource containers */
6041
+ 'hostAliases'?: {
6042
+ /** Enable support for adding /etc/hosts overrides for a container */
6043
+ 'enabled'?: boolean;
6044
+ /** Entries to add to /etc/hosts */
6045
+ 'hostEntries'?: {
6046
+ 'ipAddress': string;
6047
+ 'hostnames': string[];
6048
+ }[];
6049
+ 'restrictions'?: {
6050
+ /** Whether or not to restrict the settings to resources with specific tags */
6051
+ 'enabled': boolean;
6052
+ /** The tags which determine the resources the settings should be applied to */
6053
+ 'tags'?: string[];
6054
+ };
6055
+ };
5674
6056
  };
5675
6057
  /** time of creation Example: "2000-01-01T12:00:00.000Z" */
5676
6058
  'createdAt'?: string;
@@ -5697,9 +6079,9 @@ type PatchProjectData = {
5697
6079
  /** Whether or not to inject a Tailscale sidecar for this project's resources */
5698
6080
  'enabled'?: boolean;
5699
6081
  'restrictions'?: {
5700
- /** Whether or not to restrict the Tailscale sidecar to run only on resources with specific tags */
6082
+ /** Whether or not to restrict the settings to resources with specific tags */
5701
6083
  'enabled'?: boolean;
5702
- /** The tags which determine whether Tailscale sidecar should be added */
6084
+ /** The tags which determine the resources the settings should be applied to */
5703
6085
  'tags'?: string[];
5704
6086
  };
5705
6087
  'secrets'?: {
@@ -5707,6 +6089,21 @@ type PatchProjectData = {
5707
6089
  'authKey'?: string;
5708
6090
  };
5709
6091
  };
6092
+ 'hostAliases'?: {
6093
+ /** Enable support for adding /etc/hosts overrides for a container */
6094
+ 'enabled'?: boolean;
6095
+ /** Entries to add to /etc/hosts */
6096
+ 'hostEntries'?: {
6097
+ 'ipAddress': string;
6098
+ 'hostnames': string[];
6099
+ }[];
6100
+ 'restrictions'?: {
6101
+ /** Whether or not to restrict the settings to resources with specific tags */
6102
+ 'enabled'?: boolean;
6103
+ /** The tags which determine the resources the settings should be applied to */
6104
+ 'tags'?: string[];
6105
+ };
6106
+ };
5710
6107
  };
5711
6108
  };
5712
6109
  /** Updates a project. */
@@ -5832,8 +6229,12 @@ type CreateAddonResult = {
5832
6229
  'storage': number;
5833
6230
  /** The number of addon replicas to run. Example: 1 */
5834
6231
  'replicas': number;
5835
- /** Defines scheduling behaviour across different zones within the same region. */
5836
- 'zonalRedundancy'?: 'required' | 'disabled';
6232
+ 'zonalRedundancy'?: {
6233
+ /** Defines scheduling behaviour across different zones within the same region. */
6234
+ 'type'?: 'required' | 'disabled';
6235
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
6236
+ 'minZones'?: number;
6237
+ };
5837
6238
  };
5838
6239
  /** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
5839
6240
  'source'?: {
@@ -5899,7 +6300,37 @@ type CreateAddonResult = {
5899
6300
  /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
5900
6301
  'appId': string;
5901
6302
  /** The current state of the addon. Example: "running" */
5902
- 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
6303
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
6304
+ /** Cluster information */
6305
+ 'cluster': {
6306
+ /** The id of the cluster associated with this project. Example: "nf-europe-west" */
6307
+ 'id': string;
6308
+ /** The name of the cluster associated with this project. Example: "nf-europe-west" */
6309
+ 'name': string;
6310
+ /** Namespace this resource is located within on the cluster. Example: "ns-8zy2mcjh9zn2" */
6311
+ 'namespace'?: string;
6312
+ };
6313
+ /** time of creation */
6314
+ 'createdAt'?: string;
6315
+ /** time of update */
6316
+ 'updatedAt'?: string;
6317
+ } | {
6318
+ /** The name of the addon. Example: "Example Addon" */
6319
+ 'name': string;
6320
+ /** A description of the addon. Example: "An addon description" */
6321
+ 'description'?: string;
6322
+ /** An array of previously defined tags to help identify and group the resource. */
6323
+ 'tags'?: string[];
6324
+ /** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgresql" */
6325
+ 'type': string;
6326
+ /** The template values to be passed to the templating engine. Example: "{\"replicas\": 2}" */
6327
+ 'templateValues'?: any;
6328
+ /** Identifier for the addon. Example: "example-addon" */
6329
+ 'id': string;
6330
+ /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
6331
+ 'appId': string;
6332
+ /** The current state of the addon. Example: "running" */
6333
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
5903
6334
  /** Cluster information */
5904
6335
  'cluster': {
5905
6336
  /** The id of the cluster associated with this project. Example: "nf-europe-west" */
@@ -5942,8 +6373,12 @@ type CreateAddonData = {
5942
6373
  'storage': number;
5943
6374
  /** The number of addon replicas to run. Example: 1 */
5944
6375
  'replicas': number;
5945
- /** Defines scheduling behaviour across different zones within the same region. */
5946
- 'zonalRedundancy'?: 'required' | 'disabled';
6376
+ 'zonalRedundancy'?: {
6377
+ /** Defines scheduling behaviour across different zones within the same region. */
6378
+ 'type'?: 'required' | 'disabled';
6379
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
6380
+ 'minZones'?: number;
6381
+ };
5947
6382
  };
5948
6383
  /** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
5949
6384
  'source'?: {
@@ -6004,6 +6439,17 @@ type CreateAddonData = {
6004
6439
  /** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
6005
6440
  'retentionTime': number;
6006
6441
  }[];
6442
+ } | {
6443
+ /** The name of the addon. Example: "Example Addon" */
6444
+ 'name': string;
6445
+ /** A description of the addon. Example: "An addon description" */
6446
+ 'description'?: string;
6447
+ /** An array of previously defined tags to help identify and group the resource. */
6448
+ 'tags'?: string[];
6449
+ /** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgresql" */
6450
+ 'type': string;
6451
+ /** The template values to be passed to the templating engine. Example: "{\"replicas\": 2}" */
6452
+ 'templateValues'?: any;
6007
6453
  };
6008
6454
  /** Creates a new addon */
6009
6455
  declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
@@ -6034,8 +6480,12 @@ type PutAddonResult = {
6034
6480
  'storage': number;
6035
6481
  /** The number of addon replicas to run. Example: 1 */
6036
6482
  'replicas': number;
6037
- /** Defines scheduling behaviour across different zones within the same region. */
6038
- 'zonalRedundancy'?: 'required' | 'disabled';
6483
+ 'zonalRedundancy'?: {
6484
+ /** Defines scheduling behaviour across different zones within the same region. */
6485
+ 'type'?: 'required' | 'disabled';
6486
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
6487
+ 'minZones'?: number;
6488
+ };
6039
6489
  };
6040
6490
  /** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
6041
6491
  'source'?: {
@@ -6101,7 +6551,37 @@ type PutAddonResult = {
6101
6551
  /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
6102
6552
  'appId': string;
6103
6553
  /** The current state of the addon. Example: "running" */
6104
- 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
6554
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
6555
+ /** Cluster information */
6556
+ 'cluster': {
6557
+ /** The id of the cluster associated with this project. Example: "nf-europe-west" */
6558
+ 'id': string;
6559
+ /** The name of the cluster associated with this project. Example: "nf-europe-west" */
6560
+ 'name': string;
6561
+ /** Namespace this resource is located within on the cluster. Example: "ns-8zy2mcjh9zn2" */
6562
+ 'namespace'?: string;
6563
+ };
6564
+ /** time of creation */
6565
+ 'createdAt'?: string;
6566
+ /** time of update */
6567
+ 'updatedAt'?: string;
6568
+ } | {
6569
+ /** The name of the addon. Example: "Example Addon" */
6570
+ 'name': string;
6571
+ /** A description of the addon. Example: "An addon description" */
6572
+ 'description'?: string;
6573
+ /** An array of previously defined tags to help identify and group the resource. */
6574
+ 'tags'?: string[];
6575
+ /** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgresql" */
6576
+ 'type': string;
6577
+ /** The template values to be passed to the templating engine. Example: "{\"replicas\": 2}" */
6578
+ 'templateValues'?: any;
6579
+ /** Identifier for the addon. Example: "example-addon" */
6580
+ 'id': string;
6581
+ /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
6582
+ 'appId': string;
6583
+ /** The current state of the addon. Example: "running" */
6584
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
6105
6585
  /** Cluster information */
6106
6586
  'cluster': {
6107
6587
  /** The id of the cluster associated with this project. Example: "nf-europe-west" */
@@ -6133,7 +6613,7 @@ type PutAddonData = {
6133
6613
  'tags'?: string[];
6134
6614
  /** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgresql" */
6135
6615
  'type': string;
6136
- /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. `latest` and `-latest` will only be applied on addon creation. Example: "latest" */
6616
+ /** The version of the addon type to use. If set to `latest`, the addon will be created with the most recent addon version. If set to a major version appended with `-latest`, e.g. `14-latest`, the addon will be created with the most recent minor version belonging to that major version. Example: "latest" */
6137
6617
  'version': string;
6138
6618
  'billing': {
6139
6619
  /** The ID of the deployment plan to use. Example: "nf-compute-20" */
@@ -6144,8 +6624,12 @@ type PutAddonData = {
6144
6624
  'storage': number;
6145
6625
  /** The number of addon replicas to run. Example: 1 */
6146
6626
  'replicas': number;
6147
- /** Defines scheduling behaviour across different zones within the same region. */
6148
- 'zonalRedundancy'?: 'required' | 'disabled';
6627
+ 'zonalRedundancy'?: {
6628
+ /** Defines scheduling behaviour across different zones within the same region. */
6629
+ 'type'?: 'required' | 'disabled';
6630
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
6631
+ 'minZones'?: number;
6632
+ };
6149
6633
  };
6150
6634
  /** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
6151
6635
  'source'?: {
@@ -6206,6 +6690,17 @@ type PutAddonData = {
6206
6690
  /** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
6207
6691
  'retentionTime': number;
6208
6692
  }[];
6693
+ } | {
6694
+ /** The name of the addon. Example: "Example Addon" */
6695
+ 'name': string;
6696
+ /** A description of the addon. Example: "An addon description" */
6697
+ 'description'?: string;
6698
+ /** An array of previously defined tags to help identify and group the resource. */
6699
+ 'tags'?: string[];
6700
+ /** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgresql" */
6701
+ 'type': string;
6702
+ /** The template values to be passed to the templating engine. Example: "{\"replicas\": 2}" */
6703
+ 'templateValues'?: any;
6209
6704
  };
6210
6705
  /** Creates or updates an addon */
6211
6706
  declare class PutAddonEndpoint extends PutApiEndpoint<PutAddonRequest, PutAddonResult> {
@@ -6230,7 +6725,7 @@ type GetAddonResult = {
6230
6725
  /** The time the addon was created. Example: "2021-01-20T11:19:53.175Z" */
6231
6726
  'createdAt': string;
6232
6727
  /** The current state of the addon. Example: "running" */
6233
- 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
6728
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
6234
6729
  /** Details about the addon's specifications. */
6235
6730
  'spec': {
6236
6731
  /** The type of the addon Example: "mongodb" */
@@ -6268,6 +6763,9 @@ type GetAddonResult = {
6268
6763
  'action': 'DENY' | 'ALLOW';
6269
6764
  }[];
6270
6765
  };
6766
+ } | {
6767
+ /** The template values to be passed to the templating engine. Example: "{\"replicas\": 2}" */
6768
+ 'templateValues': string;
6271
6769
  };
6272
6770
  };
6273
6771
  /** Cluster information */
@@ -6318,8 +6816,12 @@ type PatchAddonResult = {
6318
6816
  'storage': number;
6319
6817
  /** The number of addon replicas to run. Example: 1 */
6320
6818
  'replicas': number;
6321
- /** Defines scheduling behaviour across different zones within the same region. */
6322
- 'zonalRedundancy'?: 'required' | 'disabled';
6819
+ 'zonalRedundancy'?: {
6820
+ /** Defines scheduling behaviour across different zones within the same region. */
6821
+ 'type'?: 'required' | 'disabled';
6822
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
6823
+ 'minZones'?: number;
6824
+ };
6323
6825
  };
6324
6826
  /** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
6325
6827
  'source'?: {
@@ -6385,7 +6887,37 @@ type PatchAddonResult = {
6385
6887
  /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
6386
6888
  'appId': string;
6387
6889
  /** The current state of the addon. Example: "running" */
6388
- 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'deleting' | 'deleted';
6890
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
6891
+ /** Cluster information */
6892
+ 'cluster': {
6893
+ /** The id of the cluster associated with this project. Example: "nf-europe-west" */
6894
+ 'id': string;
6895
+ /** The name of the cluster associated with this project. Example: "nf-europe-west" */
6896
+ 'name': string;
6897
+ /** Namespace this resource is located within on the cluster. Example: "ns-8zy2mcjh9zn2" */
6898
+ 'namespace'?: string;
6899
+ };
6900
+ /** time of creation */
6901
+ 'createdAt'?: string;
6902
+ /** time of update */
6903
+ 'updatedAt'?: string;
6904
+ } | {
6905
+ /** The name of the addon. Example: "Example Addon" */
6906
+ 'name': string;
6907
+ /** A description of the addon. Example: "An addon description" */
6908
+ 'description'?: string;
6909
+ /** An array of previously defined tags to help identify and group the resource. */
6910
+ 'tags'?: string[];
6911
+ /** The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint. Example: "postgresql" */
6912
+ 'type': string;
6913
+ /** The template values to be passed to the templating engine. Example: "{\"replicas\": 2}" */
6914
+ 'templateValues'?: any;
6915
+ /** Identifier for the addon. Example: "example-addon" */
6916
+ 'id': string;
6917
+ /** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
6918
+ 'appId': string;
6919
+ /** The current state of the addon. Example: "running" */
6920
+ 'status': 'preDeployment' | 'triggerAllocation' | 'allocating' | 'postDeployment' | 'running' | 'paused' | 'scaling' | 'upgrading' | 'resetting' | 'backup' | 'restore' | 'failed' | 'error' | 'errorAllocating' | 'deleting' | 'deleted';
6389
6921
  /** Cluster information */
6390
6922
  'cluster': {
6391
6923
  /** The id of the cluster associated with this project. Example: "nf-europe-west" */
@@ -6415,6 +6947,7 @@ type PatchAddonData = {
6415
6947
  'description'?: string;
6416
6948
  /** An array of previously defined tags to help identify and group the resource. */
6417
6949
  'tags'?: string[];
6950
+ 'templateValues'?: any;
6418
6951
  'billing'?: {
6419
6952
  /** The ID of the deployment plan to use. Example: "nf-compute-20" */
6420
6953
  'deploymentPlan'?: string;
@@ -6424,8 +6957,6 @@ type PatchAddonData = {
6424
6957
  'storage'?: number;
6425
6958
  /** The number of addon replicas to run. Example: 1 */
6426
6959
  'replicas'?: number;
6427
- /** Defines scheduling behaviour across different zones within the same region. */
6428
- 'zonalRedundancy'?: 'required' | 'disabled';
6429
6960
  };
6430
6961
  /** Enables access to the addon via TLS (if supported by the addon type). */
6431
6962
  'tlsEnabled'?: boolean;
@@ -6473,6 +7004,13 @@ type PatchAddonData = {
6473
7004
  /** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
6474
7005
  'retentionTime': number;
6475
7006
  }[];
7007
+ } | {
7008
+ /** A description of the addon. Example: "An addon description" */
7009
+ 'description'?: string;
7010
+ /** An array of previously defined tags to help identify and group the resource. */
7011
+ 'tags'?: string[];
7012
+ /** The template values to be passed to the templating engine. Example: "{\"replicas\": 2}" */
7013
+ 'templateValues'?: any;
6476
7014
  };
6477
7015
  /** Updates an addon */
6478
7016
  declare class PatchAddonEndpoint extends PatchApiEndpoint<PatchAddonRequest, PatchAddonResult> {
@@ -11256,6 +11794,7 @@ type StartJobRunData = {
11256
11794
  /** The ID of the deployment plan override to use. Example: "nf-compute-20" */
11257
11795
  'deploymentPlan'?: string;
11258
11796
  };
11797
+ /** Override the job run deployment source. */
11259
11798
  'deployment'?: {
11260
11799
  /** Allows for customization of docker runtime */
11261
11800
  'docker'?: {
@@ -11726,6 +12265,7 @@ type GetPreviewtemplateResult = {
11726
12265
  /** Should the git trigger only be triggered manually? */
11727
12266
  'manualOnly'?: boolean;
11728
12267
  }[];
12268
+ '$schema'?: string;
11729
12269
  'spec': any;
11730
12270
  /** Identifier for the template Example: "example-template" */
11731
12271
  'id': string;
@@ -11780,6 +12320,7 @@ type UpdatePreviewtemplateData = {
11780
12320
  'apiVersion': 'v1.1';
11781
12321
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
11782
12322
  'arguments'?: any;
12323
+ '$schema'?: string;
11783
12324
  'spec': any;
11784
12325
  /** Whether triggers are paused for this preview template. If `true`, Git triggers and webhook triggers will not create or update previews. */
11785
12326
  'paused'?: boolean;
@@ -11955,6 +12496,7 @@ type GetPreviewtemplaterunResult = {
11955
12496
  /** Should the git trigger only be triggered manually? */
11956
12497
  'manualOnly'?: boolean;
11957
12498
  }[];
12499
+ '$schema'?: string;
11958
12500
  'spec': any;
11959
12501
  'refs'?: any;
11960
12502
  /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
@@ -12011,6 +12553,7 @@ type GetReleaseflowResult = {
12011
12553
  'ciIgnoreFlagsEnabled'?: boolean;
12012
12554
  'isAllowList'?: boolean;
12013
12555
  }[];
12556
+ '$schema'?: string;
12014
12557
  /** An array of rich UI override inputs for the Release Flow template. */
12015
12558
  'richInputs'?: any[];
12016
12559
  'spec': any;
@@ -12082,6 +12625,7 @@ type UpdateReleaseflowData = {
12082
12625
  'ciIgnoreFlagsEnabled'?: boolean;
12083
12626
  'isAllowList'?: boolean;
12084
12627
  }[];
12628
+ '$schema'?: string;
12085
12629
  /** An array of rich UI override inputs for the Release Flow template. */
12086
12630
  'richInputs'?: any[];
12087
12631
  'apiVersion': string;
@@ -12211,6 +12755,7 @@ type GetReleaseflowrunResult = {
12211
12755
  'ciIgnoreFlagsEnabled'?: boolean;
12212
12756
  'isAllowList'?: boolean;
12213
12757
  }[];
12758
+ '$schema'?: string;
12214
12759
  'spec': any;
12215
12760
  'refs'?: any;
12216
12761
  /** ID of the release flow run Example: "110ddb52-bdcd-482d-8ac2-05ba580afe2f" */
@@ -12277,6 +12822,7 @@ type AbortReleaseflowrunResult = {
12277
12822
  'ciIgnoreFlagsEnabled'?: boolean;
12278
12823
  'isAllowList'?: boolean;
12279
12824
  }[];
12825
+ '$schema'?: string;
12280
12826
  'spec': any;
12281
12827
  'refs'?: any;
12282
12828
  /** ID of the release flow run Example: "110ddb52-bdcd-482d-8ac2-05ba580afe2f" */
@@ -13832,7 +14378,11 @@ type CreateServiceCombinedResult = {
13832
14378
  'organizationId'?: string;
13833
14379
  /** Array of directory groups that will have access */
13834
14380
  'directoryGroupIds'?: string[];
14381
+ /** Enforce internal traffic through SSO authentication flow */
14382
+ 'validateInternalTraffic'?: boolean;
13835
14383
  };
14384
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
14385
+ 'verificationMode'?: 'or' | 'and';
13836
14386
  };
13837
14387
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
13838
14388
  'domains'?: string[];
@@ -14026,8 +14576,12 @@ type CreateServiceCombinedResult = {
14026
14576
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
14027
14577
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
14028
14578
  };
14029
- /** Defines scheduling behaviour across different zones within the same region. */
14030
- 'zonalRedundancy'?: 'preferred' | 'disabled';
14579
+ 'zonalRedundancy'?: {
14580
+ /** Defines scheduling behaviour across different zones within the same region. */
14581
+ 'type'?: 'disabled' | 'preferred' | 'required';
14582
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
14583
+ 'minZones'?: number;
14584
+ };
14031
14585
  'gpu'?: {
14032
14586
  'enabled'?: boolean;
14033
14587
  'configuration'?: {
@@ -14141,8 +14695,12 @@ type CreateServiceCombinedData = {
14141
14695
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
14142
14696
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
14143
14697
  };
14144
- /** Defines scheduling behaviour across different zones within the same region. */
14145
- 'zonalRedundancy'?: 'preferred' | 'disabled';
14698
+ 'zonalRedundancy'?: {
14699
+ /** Defines scheduling behaviour across different zones within the same region. */
14700
+ 'type'?: 'disabled' | 'preferred' | 'required';
14701
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
14702
+ 'minZones'?: number;
14703
+ };
14146
14704
  'gpu'?: {
14147
14705
  'enabled'?: boolean;
14148
14706
  'configuration'?: {
@@ -14183,7 +14741,11 @@ type CreateServiceCombinedData = {
14183
14741
  'organizationId'?: string;
14184
14742
  /** Array of directory groups that will have access */
14185
14743
  'directoryGroupIds'?: string[];
14744
+ /** Enforce internal traffic through SSO authentication flow */
14745
+ 'validateInternalTraffic'?: boolean;
14186
14746
  };
14747
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
14748
+ 'verificationMode'?: 'or' | 'and';
14187
14749
  };
14188
14750
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
14189
14751
  'domains'?: string[];
@@ -14396,7 +14958,11 @@ type PutServiceCombinedResult = {
14396
14958
  'organizationId'?: string;
14397
14959
  /** Array of directory groups that will have access */
14398
14960
  'directoryGroupIds'?: string[];
14961
+ /** Enforce internal traffic through SSO authentication flow */
14962
+ 'validateInternalTraffic'?: boolean;
14399
14963
  };
14964
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
14965
+ 'verificationMode'?: 'or' | 'and';
14400
14966
  };
14401
14967
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
14402
14968
  'domains'?: string[];
@@ -14590,8 +15156,12 @@ type PutServiceCombinedResult = {
14590
15156
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
14591
15157
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
14592
15158
  };
14593
- /** Defines scheduling behaviour across different zones within the same region. */
14594
- 'zonalRedundancy'?: 'preferred' | 'disabled';
15159
+ 'zonalRedundancy'?: {
15160
+ /** Defines scheduling behaviour across different zones within the same region. */
15161
+ 'type'?: 'disabled' | 'preferred' | 'required';
15162
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
15163
+ 'minZones'?: number;
15164
+ };
14595
15165
  'gpu'?: {
14596
15166
  'enabled'?: boolean;
14597
15167
  'configuration'?: {
@@ -14705,8 +15275,12 @@ type PutServiceCombinedData = {
14705
15275
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
14706
15276
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
14707
15277
  };
14708
- /** Defines scheduling behaviour across different zones within the same region. */
14709
- 'zonalRedundancy'?: 'preferred' | 'disabled';
15278
+ 'zonalRedundancy'?: {
15279
+ /** Defines scheduling behaviour across different zones within the same region. */
15280
+ 'type'?: 'disabled' | 'preferred' | 'required';
15281
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
15282
+ 'minZones'?: number;
15283
+ };
14710
15284
  'gpu'?: {
14711
15285
  'enabled'?: boolean;
14712
15286
  'configuration'?: {
@@ -14747,7 +15321,11 @@ type PutServiceCombinedData = {
14747
15321
  'organizationId'?: string;
14748
15322
  /** Array of directory groups that will have access */
14749
15323
  'directoryGroupIds'?: string[];
15324
+ /** Enforce internal traffic through SSO authentication flow */
15325
+ 'validateInternalTraffic'?: boolean;
14750
15326
  };
15327
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
15328
+ 'verificationMode'?: 'or' | 'and';
14751
15329
  };
14752
15330
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
14753
15331
  'domains'?: string[];
@@ -14960,7 +15538,11 @@ type PatchServiceCombinedResult = {
14960
15538
  'organizationId'?: string;
14961
15539
  /** Array of directory groups that will have access */
14962
15540
  'directoryGroupIds'?: string[];
15541
+ /** Enforce internal traffic through SSO authentication flow */
15542
+ 'validateInternalTraffic'?: boolean;
14963
15543
  };
15544
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
15545
+ 'verificationMode'?: 'or' | 'and';
14964
15546
  };
14965
15547
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
14966
15548
  'domains'?: string[];
@@ -15154,8 +15736,12 @@ type PatchServiceCombinedResult = {
15154
15736
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
15155
15737
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
15156
15738
  };
15157
- /** Defines scheduling behaviour across different zones within the same region. */
15158
- 'zonalRedundancy'?: 'preferred' | 'disabled';
15739
+ 'zonalRedundancy'?: {
15740
+ /** Defines scheduling behaviour across different zones within the same region. */
15741
+ 'type'?: 'disabled' | 'preferred' | 'required';
15742
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
15743
+ 'minZones'?: number;
15744
+ };
15159
15745
  'gpu'?: {
15160
15746
  'enabled'?: boolean;
15161
15747
  'configuration'?: {
@@ -15237,14 +15823,21 @@ type PatchServiceCombinedData = {
15237
15823
  /** The number of instances to run the service on. Example: 1 */
15238
15824
  'instances'?: number;
15239
15825
  'buildpack'?: {
15826
+ /** Type of buildpack run configuration */
15240
15827
  'configType'?: 'default' | 'customProcess' | 'customCommand' | 'customEntrypointCustomCommand' | 'originalEntrypointCustomCommand';
15828
+ /** Custom process which should be run. Required in case where `configType` is `customProcess` */
15241
15829
  'customProcess'?: string;
15830
+ /** Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand` */
15242
15831
  'customEntrypoint'?: string;
15832
+ /** Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand` */
15243
15833
  'customCommand'?: string;
15244
15834
  };
15245
15835
  'docker'?: {
15836
+ /** Type of entrypoint & command override configuration Example: "default" */
15246
15837
  'configType'?: 'default' | 'customEntrypoint' | 'customCommand' | 'customEntrypointCustomCommand';
15838
+ /** Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand` */
15247
15839
  'customEntrypoint'?: string;
15840
+ /** Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand` */
15248
15841
  'customCommand'?: string;
15249
15842
  };
15250
15843
  'storage'?: {
@@ -15260,8 +15853,12 @@ type PatchServiceCombinedData = {
15260
15853
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
15261
15854
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
15262
15855
  };
15263
- /** Defines scheduling behaviour across different zones within the same region. */
15264
- 'zonalRedundancy'?: 'preferred' | 'disabled';
15856
+ 'zonalRedundancy'?: {
15857
+ /** Defines scheduling behaviour across different zones within the same region. */
15858
+ 'type'?: 'disabled' | 'preferred' | 'required';
15859
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
15860
+ 'minZones'?: number;
15861
+ };
15265
15862
  'gpu'?: {
15266
15863
  'enabled'?: boolean;
15267
15864
  'configuration'?: {
@@ -15302,7 +15899,11 @@ type PatchServiceCombinedData = {
15302
15899
  'organizationId'?: string;
15303
15900
  /** Array of directory groups that will have access */
15304
15901
  'directoryGroupIds'?: string[];
15902
+ /** Enforce internal traffic through SSO authentication flow */
15903
+ 'validateInternalTraffic'?: boolean;
15305
15904
  };
15905
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
15906
+ 'verificationMode'?: 'or' | 'and';
15306
15907
  };
15307
15908
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
15308
15909
  'domains'?: string[];
@@ -15503,7 +16104,11 @@ type CreateServiceDeploymentResult = {
15503
16104
  'organizationId'?: string;
15504
16105
  /** Array of directory groups that will have access */
15505
16106
  'directoryGroupIds'?: string[];
16107
+ /** Enforce internal traffic through SSO authentication flow */
16108
+ 'validateInternalTraffic'?: boolean;
15506
16109
  };
16110
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
16111
+ 'verificationMode'?: 'or' | 'and';
15507
16112
  };
15508
16113
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
15509
16114
  'domains'?: string[];
@@ -15610,8 +16215,12 @@ type CreateServiceDeploymentResult = {
15610
16215
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
15611
16216
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
15612
16217
  };
15613
- /** Defines scheduling behaviour across different zones within the same region. */
15614
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16218
+ 'zonalRedundancy'?: {
16219
+ /** Defines scheduling behaviour across different zones within the same region. */
16220
+ 'type'?: 'disabled' | 'preferred' | 'required';
16221
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16222
+ 'minZones'?: number;
16223
+ };
15615
16224
  'gpu'?: {
15616
16225
  'enabled'?: boolean;
15617
16226
  'configuration'?: {
@@ -15733,8 +16342,12 @@ type CreateServiceDeploymentData = {
15733
16342
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
15734
16343
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
15735
16344
  };
15736
- /** Defines scheduling behaviour across different zones within the same region. */
15737
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16345
+ 'zonalRedundancy'?: {
16346
+ /** Defines scheduling behaviour across different zones within the same region. */
16347
+ 'type'?: 'disabled' | 'preferred' | 'required';
16348
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16349
+ 'minZones'?: number;
16350
+ };
15738
16351
  'gpu'?: {
15739
16352
  'enabled'?: boolean;
15740
16353
  'configuration'?: {
@@ -15790,8 +16403,12 @@ type CreateServiceDeploymentData = {
15790
16403
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
15791
16404
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
15792
16405
  };
15793
- /** Defines scheduling behaviour across different zones within the same region. */
15794
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16406
+ 'zonalRedundancy'?: {
16407
+ /** Defines scheduling behaviour across different zones within the same region. */
16408
+ 'type'?: 'disabled' | 'preferred' | 'required';
16409
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16410
+ 'minZones'?: number;
16411
+ };
15795
16412
  'gpu'?: {
15796
16413
  'enabled'?: boolean;
15797
16414
  'configuration'?: {
@@ -15843,8 +16460,12 @@ type CreateServiceDeploymentData = {
15843
16460
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
15844
16461
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
15845
16462
  };
15846
- /** Defines scheduling behaviour across different zones within the same region. */
15847
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16463
+ 'zonalRedundancy'?: {
16464
+ /** Defines scheduling behaviour across different zones within the same region. */
16465
+ 'type'?: 'disabled' | 'preferred' | 'required';
16466
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16467
+ 'minZones'?: number;
16468
+ };
15848
16469
  'gpu'?: {
15849
16470
  'enabled'?: boolean;
15850
16471
  'configuration'?: {
@@ -15885,7 +16506,11 @@ type CreateServiceDeploymentData = {
15885
16506
  'organizationId'?: string;
15886
16507
  /** Array of directory groups that will have access */
15887
16508
  'directoryGroupIds'?: string[];
16509
+ /** Enforce internal traffic through SSO authentication flow */
16510
+ 'validateInternalTraffic'?: boolean;
15888
16511
  };
16512
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
16513
+ 'verificationMode'?: 'or' | 'and';
15889
16514
  };
15890
16515
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
15891
16516
  'domains'?: string[];
@@ -16009,7 +16634,11 @@ type PutServiceDeploymentResult = {
16009
16634
  'organizationId'?: string;
16010
16635
  /** Array of directory groups that will have access */
16011
16636
  'directoryGroupIds'?: string[];
16637
+ /** Enforce internal traffic through SSO authentication flow */
16638
+ 'validateInternalTraffic'?: boolean;
16012
16639
  };
16640
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
16641
+ 'verificationMode'?: 'or' | 'and';
16013
16642
  };
16014
16643
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
16015
16644
  'domains'?: string[];
@@ -16116,8 +16745,12 @@ type PutServiceDeploymentResult = {
16116
16745
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16117
16746
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16118
16747
  };
16119
- /** Defines scheduling behaviour across different zones within the same region. */
16120
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16748
+ 'zonalRedundancy'?: {
16749
+ /** Defines scheduling behaviour across different zones within the same region. */
16750
+ 'type'?: 'disabled' | 'preferred' | 'required';
16751
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16752
+ 'minZones'?: number;
16753
+ };
16121
16754
  'gpu'?: {
16122
16755
  'enabled'?: boolean;
16123
16756
  'configuration'?: {
@@ -16239,8 +16872,12 @@ type PutServiceDeploymentData = {
16239
16872
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16240
16873
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16241
16874
  };
16242
- /** Defines scheduling behaviour across different zones within the same region. */
16243
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16875
+ 'zonalRedundancy'?: {
16876
+ /** Defines scheduling behaviour across different zones within the same region. */
16877
+ 'type'?: 'disabled' | 'preferred' | 'required';
16878
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16879
+ 'minZones'?: number;
16880
+ };
16244
16881
  'gpu'?: {
16245
16882
  'enabled'?: boolean;
16246
16883
  'configuration'?: {
@@ -16296,8 +16933,12 @@ type PutServiceDeploymentData = {
16296
16933
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16297
16934
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16298
16935
  };
16299
- /** Defines scheduling behaviour across different zones within the same region. */
16300
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16936
+ 'zonalRedundancy'?: {
16937
+ /** Defines scheduling behaviour across different zones within the same region. */
16938
+ 'type'?: 'disabled' | 'preferred' | 'required';
16939
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16940
+ 'minZones'?: number;
16941
+ };
16301
16942
  'gpu'?: {
16302
16943
  'enabled'?: boolean;
16303
16944
  'configuration'?: {
@@ -16349,8 +16990,12 @@ type PutServiceDeploymentData = {
16349
16990
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16350
16991
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16351
16992
  };
16352
- /** Defines scheduling behaviour across different zones within the same region. */
16353
- 'zonalRedundancy'?: 'preferred' | 'disabled';
16993
+ 'zonalRedundancy'?: {
16994
+ /** Defines scheduling behaviour across different zones within the same region. */
16995
+ 'type'?: 'disabled' | 'preferred' | 'required';
16996
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
16997
+ 'minZones'?: number;
16998
+ };
16354
16999
  'gpu'?: {
16355
17000
  'enabled'?: boolean;
16356
17001
  'configuration'?: {
@@ -16391,7 +17036,11 @@ type PutServiceDeploymentData = {
16391
17036
  'organizationId'?: string;
16392
17037
  /** Array of directory groups that will have access */
16393
17038
  'directoryGroupIds'?: string[];
17039
+ /** Enforce internal traffic through SSO authentication flow */
17040
+ 'validateInternalTraffic'?: boolean;
16394
17041
  };
17042
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
17043
+ 'verificationMode'?: 'or' | 'and';
16395
17044
  };
16396
17045
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
16397
17046
  'domains'?: string[];
@@ -16515,7 +17164,11 @@ type PatchServiceDeploymentResult = {
16515
17164
  'organizationId'?: string;
16516
17165
  /** Array of directory groups that will have access */
16517
17166
  'directoryGroupIds'?: string[];
17167
+ /** Enforce internal traffic through SSO authentication flow */
17168
+ 'validateInternalTraffic'?: boolean;
16518
17169
  };
17170
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
17171
+ 'verificationMode'?: 'or' | 'and';
16519
17172
  };
16520
17173
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
16521
17174
  'domains'?: string[];
@@ -16622,8 +17275,12 @@ type PatchServiceDeploymentResult = {
16622
17275
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16623
17276
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16624
17277
  };
16625
- /** Defines scheduling behaviour across different zones within the same region. */
16626
- 'zonalRedundancy'?: 'preferred' | 'disabled';
17278
+ 'zonalRedundancy'?: {
17279
+ /** Defines scheduling behaviour across different zones within the same region. */
17280
+ 'type'?: 'disabled' | 'preferred' | 'required';
17281
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
17282
+ 'minZones'?: number;
17283
+ };
16627
17284
  'gpu'?: {
16628
17285
  'enabled'?: boolean;
16629
17286
  'configuration'?: {
@@ -16745,8 +17402,12 @@ type PatchServiceDeploymentData = {
16745
17402
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16746
17403
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16747
17404
  };
16748
- /** Defines scheduling behaviour across different zones within the same region. */
16749
- 'zonalRedundancy'?: 'preferred' | 'disabled';
17405
+ 'zonalRedundancy'?: {
17406
+ /** Defines scheduling behaviour across different zones within the same region. */
17407
+ 'type'?: 'disabled' | 'preferred' | 'required';
17408
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
17409
+ 'minZones'?: number;
17410
+ };
16750
17411
  'gpu'?: {
16751
17412
  'enabled'?: boolean;
16752
17413
  'configuration'?: {
@@ -16802,8 +17463,12 @@ type PatchServiceDeploymentData = {
16802
17463
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16803
17464
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16804
17465
  };
16805
- /** Defines scheduling behaviour across different zones within the same region. */
16806
- 'zonalRedundancy'?: 'preferred' | 'disabled';
17466
+ 'zonalRedundancy'?: {
17467
+ /** Defines scheduling behaviour across different zones within the same region. */
17468
+ 'type'?: 'disabled' | 'preferred' | 'required';
17469
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
17470
+ 'minZones'?: number;
17471
+ };
16807
17472
  'gpu'?: {
16808
17473
  'enabled'?: boolean;
16809
17474
  'configuration'?: {
@@ -16855,8 +17520,12 @@ type PatchServiceDeploymentData = {
16855
17520
  /** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
16856
17521
  'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
16857
17522
  };
16858
- /** Defines scheduling behaviour across different zones within the same region. */
16859
- 'zonalRedundancy'?: 'preferred' | 'disabled';
17523
+ 'zonalRedundancy'?: {
17524
+ /** Defines scheduling behaviour across different zones within the same region. */
17525
+ 'type'?: 'disabled' | 'preferred' | 'required';
17526
+ /** Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required") */
17527
+ 'minZones'?: number;
17528
+ };
16860
17529
  'gpu'?: {
16861
17530
  'enabled'?: boolean;
16862
17531
  'configuration'?: {
@@ -16897,7 +17566,11 @@ type PatchServiceDeploymentData = {
16897
17566
  'organizationId'?: string;
16898
17567
  /** Array of directory groups that will have access */
16899
17568
  'directoryGroupIds'?: string[];
17569
+ /** Enforce internal traffic through SSO authentication flow */
17570
+ 'validateInternalTraffic'?: boolean;
16900
17571
  };
17572
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
17573
+ 'verificationMode'?: 'or' | 'and';
16901
17574
  };
16902
17575
  /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
16903
17576
  'domains'?: string[];
@@ -17215,7 +17888,11 @@ type GetServiceResult = {
17215
17888
  'organizationId'?: string;
17216
17889
  /** List of directory groupIds, one of which the user has to be a member of. */
17217
17890
  'directoryGroupIds'?: string[];
17891
+ /** Enforce internal traffic through SSO authentication flow */
17892
+ 'validateInternalTraffic'?: boolean;
17218
17893
  };
17894
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
17895
+ 'verificationMode'?: 'or' | 'and';
17219
17896
  };
17220
17897
  /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
17221
17898
  'disableNfDomain'?: boolean;
@@ -18152,7 +18829,11 @@ type GetServicePortsResult = {
18152
18829
  'organizationId'?: string;
18153
18830
  /** List of directory groupIds, one of which the user has to be a member of. */
18154
18831
  'directoryGroupIds'?: string[];
18832
+ /** Enforce internal traffic through SSO authentication flow */
18833
+ 'validateInternalTraffic'?: boolean;
18155
18834
  };
18835
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
18836
+ 'verificationMode'?: 'or' | 'and';
18156
18837
  };
18157
18838
  /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
18158
18839
  'disableNfDomain'?: boolean;
@@ -18225,7 +18906,11 @@ type UpdateServicePortsData = {
18225
18906
  'organizationId'?: string;
18226
18907
  /** Array of directory groups that will have access */
18227
18908
  'directoryGroupIds'?: string[];
18909
+ /** Enforce internal traffic through SSO authentication flow */
18910
+ 'validateInternalTraffic'?: boolean;
18228
18911
  };
18912
+ /** Mode used to verify multiple security features like ip policies and SSO authentication */
18913
+ 'verificationMode'?: 'or' | 'and';
18229
18914
  };
18230
18915
  /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
18231
18916
  'disableNfDomain'?: boolean;
@@ -19124,6 +19809,7 @@ type CreateTemplateResult = {
19124
19809
  'apiVersion': 'v1.1';
19125
19810
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19126
19811
  'arguments'?: any;
19812
+ '$schema'?: string;
19127
19813
  'spec': any;
19128
19814
  /** Identifier for the template Example: "example-template" */
19129
19815
  'id': string;
@@ -19163,6 +19849,7 @@ type CreateTemplateResult = {
19163
19849
  'apiVersion': 'v1.1';
19164
19850
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19165
19851
  'arguments'?: any;
19852
+ '$schema'?: string;
19166
19853
  'spec': any;
19167
19854
  'refs'?: any;
19168
19855
  /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
@@ -19192,6 +19879,7 @@ type CreateTemplateData = {
19192
19879
  'apiVersion': 'v1.1';
19193
19880
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19194
19881
  'arguments'?: any;
19882
+ '$schema'?: string;
19195
19883
  'spec': any;
19196
19884
  /** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
19197
19885
  'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
@@ -19215,6 +19903,7 @@ type CreateTemplateData = {
19215
19903
  'apiVersion': 'v1.1';
19216
19904
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19217
19905
  'arguments'?: any;
19906
+ '$schema'?: string;
19218
19907
  'spec': any;
19219
19908
  /** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
19220
19909
  'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
@@ -19251,6 +19940,7 @@ type CreateTemplateData = {
19251
19940
  'description'?: string;
19252
19941
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19253
19942
  'arguments'?: any;
19943
+ '$schema'?: string;
19254
19944
  /** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
19255
19945
  'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
19256
19946
  /** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
@@ -19299,6 +19989,7 @@ type GetTemplateResult = {
19299
19989
  'apiVersion': 'v1.1';
19300
19990
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19301
19991
  'arguments'?: any;
19992
+ '$schema'?: string;
19302
19993
  'spec': any;
19303
19994
  /** Identifier for the template Example: "example-template" */
19304
19995
  'id': string;
@@ -19365,6 +20056,7 @@ type UpdateTemplateResult = {
19365
20056
  'apiVersion': 'v1.1';
19366
20057
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19367
20058
  'arguments'?: any;
20059
+ '$schema'?: string;
19368
20060
  'spec': any;
19369
20061
  /** Identifier for the template Example: "example-template" */
19370
20062
  'id': string;
@@ -19404,6 +20096,7 @@ type UpdateTemplateResult = {
19404
20096
  'apiVersion': 'v1.1';
19405
20097
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19406
20098
  'arguments'?: any;
20099
+ '$schema'?: string;
19407
20100
  'spec': any;
19408
20101
  'refs'?: any;
19409
20102
  /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
@@ -19437,6 +20130,7 @@ type UpdateTemplateData = {
19437
20130
  'apiVersion': 'v1.1';
19438
20131
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19439
20132
  'arguments'?: any;
20133
+ '$schema'?: string;
19440
20134
  'spec': any;
19441
20135
  /** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
19442
20136
  'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
@@ -19456,6 +20150,7 @@ type UpdateTemplateData = {
19456
20150
  'apiVersion': 'v1.1';
19457
20151
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19458
20152
  'arguments'?: any;
20153
+ '$schema'?: string;
19459
20154
  'spec': any;
19460
20155
  /** Defines the concurrency behaviour of the template with respect to parallel runs. Example: "allow" */
19461
20156
  'concurrencyPolicy'?: 'allow' | 'queue' | 'forbid';
@@ -19546,6 +20241,7 @@ type RunTemplateResult = {
19546
20241
  'apiVersion': 'v1.1';
19547
20242
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19548
20243
  'arguments'?: any;
20244
+ '$schema'?: string;
19549
20245
  'spec': any;
19550
20246
  'refs'?: any;
19551
20247
  /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
@@ -19643,6 +20339,7 @@ type GetTemplaterunResult = {
19643
20339
  'apiVersion': 'v1.1';
19644
20340
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19645
20341
  'arguments'?: any;
20342
+ '$schema'?: string;
19646
20343
  'spec': any;
19647
20344
  'refs'?: any;
19648
20345
  /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
@@ -19685,6 +20382,7 @@ type AbortTemplaterunResult = {
19685
20382
  'apiVersion': 'v1.1';
19686
20383
  /** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
19687
20384
  'arguments'?: any;
20385
+ '$schema'?: string;
19688
20386
  'spec': any;
19689
20387
  'refs'?: any;
19690
20388
  /** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */