Create combined service

• enabled

  boolean

• configuration

  {object}

• gpuType

  string required

• gpuCount

  integer

• timesliced

  boolean

• name

  string required
  The name used to identify the port.
  min length

  1

  max length

  8

  pattern

  ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• internalPort

  integer required
  The port number.
  min

  1

  max

  65535

• public

  boolean
  If true, the port will be exposed publicly.

• security

  {object}

• credentials

  [array]
  An array of credentials to access the service.
• {object}

• username

  string required
  The username to access the service
  min length

  3

  max length

  39

  pattern

  ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• password

  string required
  The password to access the service with this username.

• type

  string required
  The type of authentication used
  one of

  basic-auth

• ip

  [array]
  An array of IP address policies.
• {object}

• addresses

  [array] required
  An array of IP addresses used for this rule
• string
  An IP address used by this rule

• action

  string required
  The action for this rule.
  one of

  ALLOW, DENY

• policies

  [array]
  An array of IP address policies.
• {object}

• addresses

  [array] required
  An array of IP addresses used for this rule
• string
  An IP address used by this rule

• action

  string required
  The action for this rule.
  one of

  ALLOW, DENY

• sso

  {object}
  Configure port authentication via SSO

• organizationId

  string
  ID of the SSO organization that the user will have to be a member of

• directoryGroupIds

  [array]
  Array of directory groups that will have access
• string

• validateInternalTraffic

  boolean
  Enforce internal traffic through SSO authentication flow

• setCookieOnRootDomain

  boolean
  Set SSO authentication cookie on root domain

• allowInternalTrafficViaPublicDns

  boolean
  Allow internal traffic from same or shared projects via public DNS to skip SSO authentication flow

• headers

  [array]
  List of header authentication settings, it checks the presence of all headers and compares it against the expected value. Wildcard (*) is supported.
• (multiple options: anyOf)
{object}
Matches provided headers as strings.
• regexMode

  boolean

• name

  string required
  pattern

  ^[a-zA-Z0-9_\-%$+]+$

• value

  string required

OR

{object}
Matches provided headers as regex.
• regexMode

  boolean

• name

  string required

• value

  string required

• verificationMode

  string
  Mode used to verify multiple security features like ip policies and SSO authentication
  one of

  or, and

• securePathConfiguration

  {object}

• enabled

  boolean
  Enable security policies on a path-level style

• skipSecurityPoliciesForInternalTrafficViaPublicDns

  boolean
  Allow internal traffic from same or shared projects via public DNS to skip all security policies

• rules

  [array]
• {object}

• paths

  [array] required
  Array of path objects which represent the paths and their priority for which the security policies will be enforced
• (multiple options: oneOf)
  Data about how the path should be handled.
{object}
Route when the path starts with the provided prefix.
• path

  string required
  pattern

  ^\/([_a-zA-Z0-9-&?=.]*)((\/[_a-zA-Z0-9-&?=.]+)*(\/)?)?$

• routingMode

  string required
  Mode of the path, determining how the URI will be interpreted.
  one of

  prefix

• priority

  integer required
  min

  0

  max

  100

OR

{object}
Route when the path is an exact match.
• path

  string required
  pattern

  ^\/([_a-zA-Z0-9-&?=.]*)((\/[_a-zA-Z0-9-&?=.]+)*(\/)?)?$

• routingMode

  string required
  Mode of the path, determining how the URI will be interpreted.
  one of

  exact

• priority

  integer required
  min

  0

  max

  100

OR

{object}
Route when the path matches the provided regex.
• path

  string required

• routingMode

  string required
  Mode of the path, determining how the URI will be interpreted.
  one of

  regex

• priority

  integer required
  min

  0

  max

  100

• accessMode

  string required
  Specify the way the path rule will behave when processing policies. This enables an allow-list/deny-list approach for access control on each path
  one of

  protected, unprotected

• securityPolicies

  {object}

• orPolicies

  {object}

• credentials

  [array]
  An array of credentials to access the service.
• {object}

• username

  string required
  The username to access the service
  min length

  3

  max length

  39

  pattern

  ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• password

  string required
  The password to access the service with this username.

• type

  string required
  The type of authentication used
  one of

  basic-auth

• ip

  [array]
  An array of IP address policies.
• {object}

• addresses

  [array] required
  An array of IP addresses used for this rule
• string
  An IP address used by this rule

• action

  string required
  The action for this rule.
  one of

  ALLOW, DENY

• policies

  [array]
  An array of IP address policies.
• {object}

• addresses

  [array] required
  An array of IP addresses used for this rule
• string
  An IP address used by this rule

• action

  string required
  The action for this rule.
  one of

  ALLOW, DENY

• sso

  {object}
  Configure port authentication via SSO

• organizationId

  string
  ID of the SSO organization that the user will have to be a member of

• directoryGroupIds

  [array]
  Array of directory groups that will have access
• string

• validateInternalTraffic

  boolean
  Enforce internal traffic through SSO authentication flow

• setCookieOnRootDomain

  boolean
  Set SSO authentication cookie on root domain

• allowInternalTrafficViaPublicDns

  boolean
  Allow internal traffic from same or shared projects via public DNS to skip SSO authentication flow

• headers

  [array]
  List of header authentication settings, it checks the presence of all headers and compares it against the expected value. Wildcard (*) is supported.
• (multiple options: anyOf)
{object}
Matches provided headers as strings.
• regexMode

  boolean

• name

  string required
  pattern

  ^[a-zA-Z0-9_\-%$+]+$

• value

  string required

OR

{object}
Matches provided headers as regex.
• regexMode

  boolean

• name

  string required

• value

  string required

• requiredPolicies

  {object}

• credentials

  [array]
  An array of credentials to access the service.
• {object}

• username

  string required
  The username to access the service
  min length

  3

  max length

  39

  pattern

  ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• password

  string required
  The password to access the service with this username.

• type

  string required
  The type of authentication used
  one of

  basic-auth

• ip

  [array]
  An array of IP address policies.
• {object}

• addresses

  [array] required
  An array of IP addresses used for this rule
• string
  An IP address used by this rule

• action

  string required
  The action for this rule.
  one of

  ALLOW, DENY

• policies

  [array]
  An array of IP address policies.
• {object}

• addresses

  [array] required
  An array of IP addresses used for this rule
• string
  An IP address used by this rule

• action

  string required
  The action for this rule.
  one of

  ALLOW, DENY

• sso

  {object}
  Configure port authentication via SSO

• organizationId

  string
  ID of the SSO organization that the user will have to be a member of

• directoryGroupIds

  [array]
  Array of directory groups that will have access
• string

• validateInternalTraffic

  boolean
  Enforce internal traffic through SSO authentication flow

• setCookieOnRootDomain

  boolean
  Set SSO authentication cookie on root domain

• allowInternalTrafficViaPublicDns

  boolean
  Allow internal traffic from same or shared projects via public DNS to skip SSO authentication flow

• headers

  [array]
  List of header authentication settings, it checks the presence of all headers and compares it against the expected value. Wildcard (*) is supported.
• (multiple options: anyOf)
{object}
Matches provided headers as strings.
• regexMode

  boolean

• name

  string required
  pattern

  ^[a-zA-Z0-9_\-%$+]+$

• value

  string required

OR

{object}
Matches provided headers as regex.
• regexMode

  boolean

• name

  string required

• value

  string required

• domains

  [array]
  An array of domains to redirect to this port. Each domain must first be verified and registered to your account.
• string
  A domain to redirect to this port.

• disableNfDomain

  boolean
  Disable routing on the default code.run domain for public HTTP ports with custom domains.

• advancedOptions

  {object}

• enableTlsPassthrough

  boolean
  Whether this port should use pass through mode for TLS

• protocol

  (multiple options: oneOf) required
  The protocol to use for the port.
string
one of
HTTP, HTTP/2

OR

string
one of
HTTP, HTTP/2, TCP, UDP

OR

• string
  A path ignore rule, following `.gitignore` syntax. For example, `*.md` will ignore all files ending with `.md`.
  max length

  260

• string
  A commit ignore flag.
  max length

  72

• string
  The ID of the docker credentials to use.
  pattern

  ^[A-Za-z0-9-]+$

• ephemeralStorage

  {object}

• storageSize

  integer
  Ephemeral storage per build in MB
  one of

  16384, 32768, 65536, 131072, 262144, 524288
  min

  16384

  max

  65536

• protocol

  string required
  The protocol to access the health check with.
  one of

  HTTP, CMD, TCP

• type

  string required
  The type of health check.
  one of

  livenessProbe, readinessProbe, startupProbe

• path

  string
  The path of the health check endpoint. Required when protocol is HTTP.
  pattern

  ^\/([a-zA-Z0-9-._]+\/)*[a-zA-Z0-9-._]+$

• cmd

  string
  The command to run for the health check. Required when protocol is CMD

• port

  integer
  Port number for the health check endpoint. Required when protocol is HTTP.
  min

  1

• initialDelaySeconds

  integer required
  Initial delay, in seconds, before the health check is first run.
  min

  1

  max

  180

• periodSeconds

  integer required
  The time between each check, in seconds.
  min

  10

  max

  600

• timeoutSeconds

  integer required
  The time to wait for a response before marking the health check as a failure.
  min

  1

  max

  60

• failureThreshold

  integer required
  The maximum number of allowed failures.
  min

  1

  max

  255

• successThreshold

  integer
  The number of successes required to mark the health check as a success.
  min

  1

  max

  255

• mode

  string required
  one of

  ip, customHeader

• header

  string

• mode

  string required
  one of

  path, header

• enabled

  boolean required
  Whether horizontal autoscaling should be enabled

• minReplicas

  number required
  Minimum number of replicas which should be running at any time
  min

  1

• maxReplicas

  number required
  Maximum number of replicas which can be running at any time

• cpu

  {object}

• enabled

  boolean required
  Whether autoscaling should take into account cpu usage

• thresholdPercentage

  integer required
  Threshold CPU usage percentage at which the workload will be scaled
  min

  10

  max

  100

• memory

  {object}

• enabled

  boolean required
  Whether autoscaling should take into account memory usage

• thresholdPercentage

  integer required
  Threshold memory usage percentage at which the workload will be scaled
  min

  10

  max

  100

• rps

  {object}

• enabled

  boolean required
  Whether autoscaling should take into requests-per-second

• thresholdValue

  integer required
  Threshold rps value on which the workload will be scaled
  min

  1

• userMetrics

  {object}

• enabled

  boolean required
  Whether to enable handling for custom metrics in the autoscaling configuration

• exposedMetricsPath

  string required
  Path on which the metrics will be exposed by the service..
  pattern

  ^\/([_a-zA-Z0-9-&?=.]*)((\/[_a-zA-Z0-9-&?=.]+)*(\/)?)?$

• exposedMetricsPort

  integer required
  Port on which the metrics will be exposed by the service.

• metrics

  [array] required
  Array of custom metrics exposed by the service that will be used by the autoscaling configuration. At least one metric is required.
• {object}

• metricName

  string required
  Name of the custom metric
  pattern

  [a-zA-Z_:][a-zA-Z0-9_:]*$

• metricType

  string required
  Type of metric exposed, this will affect how it'll be queried by the autoscaler component: Gauge will be used as is, Counter will be used with rate()
  one of

  gauge, counter

• thresholdValue

  number required
  Threshold value on which the workload will be scaled. Represents the average value across all running pods.

• configType

  string required
  Type of buildpack run configuration
  one of

  default, customProcess, customCommand, customEntrypointCustomCommand, originalEntrypointCustomCommand

• customProcess

  string
  Custom process which should be run. Required in case where `configType` is `customProcess`

• customEntrypoint

  string
  Custom entrypoint which should be run. Required in case where `configType` is `customEntrypointCustomCommand`

• customCommand

  string
  Custom command which should be run. Required in case where `configType` is `customCommand`, `customEntrypointCustomCommand` or `originalEntrypointCustomCommand`

• configType

  string required
  Type of entrypoint & command override configuration
  one of

  default, customEntrypoint, customCommand, customEntrypointCustomCommand

• customEntrypoint

  string
  Custom entrypoint which should be used. Required in case where `configType` is `customEntrypoint` or `customEntrypointCustomCommand`

• customCommand

  string
  Custom command which should be used. Required in case where `configType` is `customCommand` or `customEntrypointCustomCommand`

• ephemeralStorage

  {object}

• storageSize

  integer
  Ephemeral storage per container in MB
  min

  1024

• shmSize

  integer
  Configures the amount of available memory-backed disk space available to /dev/shm
  min

  64

• type

  string
  Configures the instance roll out strategy of your service. Currently only available via feature flag.
  one of

  recreate, rollout-steady, rollout-balanced, rollout-fast

• type

  string
  Defines scheduling behaviour across different zones within the same region.
  one of

  disabled, preferred, required

• minZones

  integer
  Defines how many zones are required and will prevent containers from additional scheduling into existing zones. (Only relevant if type is set to "required")
  min

  1

• enabled

  boolean

• configuration

  {object}

• gpuType

  string required

• gpuCount

  integer

• timesliced

  boolean

• labels

  {object}
  Specify custom labels for the workload.

• annotations

  {object}
  Specify custom annotations for the workload as string or object.

• string

• status

  string required
  The current status of the build.
  one of

  QUEUED, PENDING, UNSCHEDULABLE, STARTING, CLONING, BUILDING, UPLOADING, ABORTED, FAILURE, SUBMISSION_FAILURE, SUCCESS, CRASHED, IN_PROGRESS

• lastTransitionTime

  string
  The timestamp of when the build reached this status.

• status

  string required
  The current status of the deployment.
  one of

  PENDING, IN_PROGRESS, COMPLETED, FAILED

• reason

  string required
  The reason the current deployment was started.
  one of

  SCALING, DEPLOYING

• lastTransitionTime

  string
  The timestamp of when the deployment reached this status.