@northflank/js-client 0.6.3-beta.0 → 0.7.0

package/dist/cjs/api-client.d.ts

@@ -3365,7 +3365,7 @@ declare type UpdateJobHealthchecksParameters = {
     'jobId': string;
 };
 declare type UpdateJobHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -3375,7 +3375,7 @@ declare type UpdateJobHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;
@@ -5380,6 +5380,29 @@ declare type CreateServiceCombinedData = {
     'buildArguments'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'buildFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new combined service. */
 declare class CreateServiceCombinedEndpoint extends PostApiEndpoint<CreateServiceCombinedRequest, CreateServiceCombinedResult> {
@@ -5599,6 +5622,29 @@ declare type CreateServiceDeploymentData = {
     'runtimeEnvironment'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'runtimeFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new deployment service. */
 declare class CreateServiceDeploymentEndpoint extends PostApiEndpoint<CreateServiceDeploymentRequest, CreateServiceDeploymentResult> {
@@ -6518,7 +6564,7 @@ declare type UpdateServiceHealthchecksParameters = {
     'serviceId': string;
 };
 declare type UpdateServiceHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -6528,7 +6574,7 @@ declare type UpdateServiceHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;

package/dist/cjs/endpoints/create/service/combined.d.ts

@@ -221,6 +221,29 @@ export declare type CreateServiceCombinedData = {
     'buildArguments'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'buildFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new combined service. */
 export declare class CreateServiceCombinedEndpoint extends PostApiEndpoint<CreateServiceCombinedRequest, CreateServiceCombinedResult> {

package/dist/cjs/endpoints/create/service/deployment.d.ts

@@ -208,6 +208,29 @@ export declare type CreateServiceDeploymentData = {
     'runtimeEnvironment'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'runtimeFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new deployment service. */
 export declare class CreateServiceDeploymentEndpoint extends PostApiEndpoint<CreateServiceDeploymentRequest, CreateServiceDeploymentResult> {

package/dist/cjs/endpoints/update/job/healthChecks.d.ts

@@ -11,7 +11,7 @@ export declare type UpdateJobHealthchecksParameters = {
     'jobId': string;
 };
 export declare type UpdateJobHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -21,7 +21,7 @@ export declare type UpdateJobHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;

package/dist/cjs/endpoints/update/service/healthChecks.d.ts

@@ -11,7 +11,7 @@ export declare type UpdateServiceHealthchecksParameters = {
     'serviceId': string;
 };
 export declare type UpdateServiceHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -21,7 +21,7 @@ export declare type UpdateServiceHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;

package/dist/esm/api-client.d.ts

@@ -3365,7 +3365,7 @@ declare type UpdateJobHealthchecksParameters = {
     'jobId': string;
 };
 declare type UpdateJobHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -3375,7 +3375,7 @@ declare type UpdateJobHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;
@@ -5380,6 +5380,29 @@ declare type CreateServiceCombinedData = {
     'buildArguments'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'buildFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new combined service. */
 declare class CreateServiceCombinedEndpoint extends PostApiEndpoint<CreateServiceCombinedRequest, CreateServiceCombinedResult> {
@@ -5599,6 +5622,29 @@ declare type CreateServiceDeploymentData = {
     'runtimeEnvironment'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'runtimeFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new deployment service. */
 declare class CreateServiceDeploymentEndpoint extends PostApiEndpoint<CreateServiceDeploymentRequest, CreateServiceDeploymentResult> {
@@ -6518,7 +6564,7 @@ declare type UpdateServiceHealthchecksParameters = {
     'serviceId': string;
 };
 declare type UpdateServiceHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -6528,7 +6574,7 @@ declare type UpdateServiceHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;

package/dist/esm/endpoints/create/service/combined.d.ts

@@ -221,6 +221,29 @@ export declare type CreateServiceCombinedData = {
     'buildArguments'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'buildFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new combined service. */
 export declare class CreateServiceCombinedEndpoint extends PostApiEndpoint<CreateServiceCombinedRequest, CreateServiceCombinedResult> {

package/dist/esm/endpoints/create/service/deployment.d.ts

@@ -208,6 +208,29 @@ export declare type CreateServiceDeploymentData = {
     'runtimeEnvironment'?: any;
     /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
     'runtimeFiles'?: any;
+    /** An array of health checks. */
+    'healthChecks'?: {
+        /** The protocol to access the health check with. Example: "HTTP" */
+        'protocol': 'HTTP' | 'CMD' | 'TCP';
+        /** The type of health check. Example: "readinessProbe" */
+        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
+        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
+        'path'?: string;
+        /** The command to run for the health check. Required when protocol is CMD */
+        'cmd'?: string;
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
+        'port'?: number;
+        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
+        'initialDelaySeconds': number;
+        /** The time between each check, in seconds. Example: 60 */
+        'periodSeconds': number;
+        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
+        'timeoutSeconds': number;
+        /** The maximum number of allowed failures. Example: 3 */
+        'failureThreshold': number;
+        /** The number of successes required to mark the health check as a success. Example: 1 */
+        'successThreshold'?: number;
+    }[];
 };
 /** Creates a new deployment service. */
 export declare class CreateServiceDeploymentEndpoint extends PostApiEndpoint<CreateServiceDeploymentRequest, CreateServiceDeploymentResult> {

package/dist/esm/endpoints/update/job/healthChecks.d.ts

@@ -11,7 +11,7 @@ export declare type UpdateJobHealthchecksParameters = {
     'jobId': string;
 };
 export declare type UpdateJobHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -21,7 +21,7 @@ export declare type UpdateJobHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;

package/dist/esm/endpoints/update/service/healthChecks.d.ts

@@ -11,7 +11,7 @@ export declare type UpdateServiceHealthchecksParameters = {
     'serviceId': string;
 };
 export declare type UpdateServiceHealthchecksData = {
-    /** An array of health checks */
+    /** An array of health checks. */
     'healthChecks': {
         /** The protocol to access the health check with. Example: "HTTP" */
         'protocol': 'HTTP' | 'CMD' | 'TCP';
@@ -21,7 +21,7 @@ export declare type UpdateServiceHealthchecksData = {
         'path'?: string;
         /** The command to run for the health check. Required when protocol is CMD */
         'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 3000 */
+        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
         'port'?: number;
         /** Initial delay, in seconds, before the health check is first run. Example: 10 */
         'initialDelaySeconds': number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@northflank/js-client",
-  "version": "0.6.3-beta.0",
+  "version": "0.7.0",
   "license": "MIT",
   "author": "Marco Suter",
   "main": "dist/cjs/api-client.js",