{ "components": { "parameters": { "version": { "description": "The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any\ndate between `2021-03-31` and `2026-10-11`.", "example": "2026-10-11", "in": "query", "name": "version", "schema": { "maxLength": 10, "minLength": 10, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string" }, "x-sdk-global-param": true } }, "schemas": { "AllowedOutboundDestination": { "description": "AllowedOutboundDestination Describes the model of an allowed outbound destination.", "example": { "cidr_block": "192.168.3.0/24", "entity_tag": "2385407409", "name": "my-cidr-block", "status": "ready", "type": "cidr_block" }, "oneOf": [ { "$ref": "#/components/schemas/CidrBlockData" }, { "$ref": "#/components/schemas/PrivatePathServiceGatewayData" } ], "properties": { "entity_tag": { "description": "The version of the allowed outbound destination, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "name": { "description": "The name of the allowed outbound destination.", "example": "allow-all", "type": "string", "x-terraform-force-new": true }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "status": { "description": "The current status of the outbound destination.", "enum": [ "ready", "failed", "deploying" ], "example": "ready", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/AllowedOutboundStatusDetails" }, "type": { "default": "cidr_block", "description": "Specify the type of the allowed outbound destination. Allowed types are: `cidr_block` and `private_path_service_gateway`.", "enum": [ "cidr_block", "private_path_service_gateway" ], "example": "cidr_block", "pattern": "^(cidr_block|private_path_service_gateway)$", "type": "string", "x-terraform-force-new": true } }, "required": [ "status", "type" ], "type": "object", "x-data-source-name": "code_engine_allowed_outbound_destination", "x-data-source-operations": { "read": "get_allowed_outbound_destination" }, "x-resource-name": "code_engine_allowed_outbound_destination", "x-resource-operations": { "create": "create_allowed_outbound_destination", "delete": "delete_allowed_outbound_destination", "read": "get_allowed_outbound_destination", "update": "update_allowed_outbound_destination" } }, "AllowedOutboundDestinationList": { "description": "Contains a list of allowed outbound destinations and pagination information.", "example": { "allowed_outbound_destinations": [ { "cidr_block": "192.168.3.0/24", "entity_tag": "2385407409", "name": "my-cidr-block", "status": "ready", "type": "cidr_block" } ], "limit": 50 }, "properties": { "allowed_outbound_destinations": { "description": "List of all allowed outbound destinations.", "items": { "$ref": "#/components/schemas/AllowedOutboundDestination" }, "maxItems": 500, "minItems": 0, "type": "array" }, "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "allowed_outbound_destinations", "limit" ], "type": "object" }, "AllowedOutboundDestinationPatch": { "description": "The request model for allowed outbound destination update operations.", "example": { "cidr_block": "192.168.3.0/24" }, "oneOf": [ { "$ref": "#/components/schemas/CidrBlockDataPatch" }, { "$ref": "#/components/schemas/PrivatePathServiceGatewayDataPatch" } ], "properties": {}, "type": "object" }, "AllowedOutboundDestinationPrototype": { "description": "AllowedOutboundDestinationPrototype is the request model for allowed outbound destination create operations.", "example": { "cidr_block": "192.168.3.0/24", "name": "my-cidr-block", "type": "cidr_block" }, "oneOf": [ { "$ref": "#/components/schemas/CidrBlockDataPrototype" }, { "$ref": "#/components/schemas/PrivatePathServiceGatewayDataPrototype" } ], "properties": { "name": { "description": "The name of the allowed outbound destination.", "example": "allow-all", "type": "string" }, "type": { "default": "cidr_block", "description": "Specify the type of the allowed outbound destination. Allowed types are: `cidr_block` and `private_path_service_gateway`.", "enum": [ "cidr_block", "private_path_service_gateway" ], "example": "cidr_block", "pattern": "^(cidr_block|private_path_service_gateway)$", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "AllowedOutboundStatusDetails": { "oneOf": [ { "$ref": "#/components/schemas/PrivatePathServiceGatewayStatusDetails" } ], "properties": {}, "type": "object" }, "App": { "description": "App is the response model for app resources.", "example": { "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "endpoint_internal": "http://my-app.uyh5shf7s0f.svc.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "managed_domain_mappings": "local_public", "name": "my-app", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_down_delay": 0, "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" }, "properties": { "build": { "description": "Reference to a build that is associated with the application.", "example": "my-build", "readOnly": true, "type": "string" }, "build_run": { "description": "Reference to a build run that is associated with the application.", "example": "my-build-run", "readOnly": true, "type": "string" }, "computed_env_variables": { "description": "References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "endpoint": { "description": "Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only.\nEmpty in case 'managed_domain_mappings' is set to 'local'.", "example": "https://my-app.uyh5shf7s0f.eu-de.codeengine.appdomain.cloud", "readOnly": true, "type": "string" }, "endpoint_internal": { "description": "The URL to the app that is only visible within the project.", "example": "http://my-app.uyh5shf7s0f.svc.cluster.local", "readOnly": true, "type": "string" }, "entity_tag": { "description": "The version of the app instance, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "href": { "description": "When you provision a new app, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/apps/my-app", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "image_port": { "default": 8080, "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", "example": 8080, "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "image_reference": { "description": "The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "managed_domain_mappings": { "default": "local_public", "description": "Optional value controlling which of the system managed domain mappings will be setup for the application.\nValid values are 'local_public', 'local_private' and 'local'.\nVisibility can only be 'local_private' if the project supports application private visibility.", "enum": [ "local", "local_private", "local_public" ], "example": "local_public", "type": "string" }, "name": { "description": "The name of the app.", "example": "my-app", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string", "x-terraform-force-new": true }, "probe_liveness": { "$ref": "#/components/schemas/Probe" }, "probe_readiness": { "$ref": "#/components/schemas/Probe" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the app.", "enum": [ "app_v2" ], "readOnly": true, "type": "string" }, "run_arguments": { "description": "Optional arguments for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "Optional user ID (UID) to run the app.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Optional commands for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "References to config maps, secrets or literal values, which are defined by the app owner and are exposed as environment variables in the application.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_service_account": { "default": "default", "description": "Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Mounts of config maps or secrets.", "items": { "$ref": "#/components/schemas/VolumeMount" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_concurrency": { "default": 100, "description": "Optional maximum number of requests that can be processed concurrently per instance.", "example": 100, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_concurrency_target": { "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created.\nUse this value to scale up instances based on concurrent number of requests.\nThis option defaults to the value of the `scale_concurrency` option, if not specified.", "example": 80, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_cpu_limit": { "default": "1", "description": "Optional number of CPU set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": 0, "description": "Optional amount of time in seconds that delays the scale-down behavior for an app instance.", "example": 300, "format": "int64", "maximum": 3600, "minimum": 0, "type": "integer" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "Optional amount of ephemeral storage to set for the instance of the app.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_initial_instances": { "default": 1, "description": "Optional initial number of instances that are created upon app creation or app update.", "example": 1, "format": "int64", "type": "integer" }, "scale_max_instances": { "default": 10, "description": "Optional maximum number of instances for this app.\nIf you set this value to `0`, this property does not set a upper scaling limit.\nHowever, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", "example": 10, "format": "int64", "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_min_instances": { "default": 0, "description": "Optional minimum number of instances for this app.\nIf you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", "example": 1, "format": "int64", "type": "integer" }, "scale_request_timeout": { "default": 300, "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", "example": 300, "format": "int64", "type": "integer" }, "status": { "description": "The current status of the app.", "enum": [ "ready", "deploying", "failed", "warning" ], "example": "ready", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/AppStatus" } }, "required": [ "managed_domain_mappings", "created_at", "computed_env_variables", "entity_tag", "href", "id", "image_reference", "project_id", "region", "name", "run_arguments", "run_commands", "run_env_variables", "run_service_account", "run_volume_mounts", "scale_cpu_limit", "scale_ephemeral_storage_limit", "scale_max_instances", "scale_memory_limit", "scale_min_instances", "scale_request_timeout", "status", "resource_type" ], "type": "object", "x-data-source-name": "code_engine_app", "x-data-source-operations": { "read": "get_app" }, "x-resource-name": "code_engine_app", "x-resource-operations": { "create": "create_app", "delete": "delete_app", "read": "get_app", "update": "update_app" }, "x-terraform-timeouts": { "create": 10, "delete": 10, "update": 10 } }, "AppInstance": { "description": "AppInstance is the response model for app instance resources.", "properties": { "app_name": { "description": "The name of the application that is associated with this instance.", "example": "my-app", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "href": { "description": "When you provision a new app instance, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/apps/my-app/instances", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "readOnly": true, "type": "string" }, "name": { "description": "The name of the app instance.", "example": "my-app-00001-deployment-6c9b5cf966-wjs44", "readOnly": true, "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the app instance.", "enum": [ "app_instance_v2" ], "readOnly": true, "type": "string" }, "revision_name": { "description": "The name of the revision that is associated with this instance.", "example": "my-app", "type": "string" }, "scale_cpu_limit": { "default": "1", "description": "The number of CPU set for the instance.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "The amount of ephemeral storage set for the instance.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_memory_limit": { "default": "4G", "description": "The amount of memory set for the instance.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "status": { "description": "The current status of the instance.", "enum": [ "pending", "running", "succeeded", "failed" ], "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/AppInstanceStatusDetails" } }, "required": [ "app_name", "created_at", "href", "id", "name", "project_id", "region", "resource_type", "revision_name", "scale_cpu_limit", "scale_ephemeral_storage_limit", "scale_memory_limit", "status" ], "type": "object" }, "AppInstanceList": { "description": "Contains a list of app instances and pagination information.", "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/instances?limit=50" }, "instances": [ { "app_name": "crash", "created_at": "2023-10-23T11:56:46-04:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/instances", "id": "7755a00a-0d8f-4eab-8dbd-ab43fc3498dd", "name": "crash-00001-deployment-86c64f66fd-cjwqp", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_instance_v2", "revision_name": "crash-00001", "scale_cpu_limit": "0.125", "scale_ephemeral_storage_limit": "400M", "scale_memory_limit": "250M", "status": "running", "status_details": { "restarts": 58, "system_containers": { "current_state": { "container_status": "running", "start_time": "2023-10-23T11:57:10-04:00" }, "last_observed_state": {} }, "user_container": { "current_state": { "completed_at": "2023-10-23T16:56:02-04:00", "container_status": "terminated", "exit_code": 1, "reason": "OOMKilled", "started_at": "2023-10-23T16:55:36-04:00" }, "last_observed_state": { "completed_at": "2023-10-23T16:50:24-04:00", "container_status": "terminated", "exit_code": 1, "reason": "OOMKilled", "started_at": "2023-10-23T16:49:58-04:00" } } } } ], "limit": 50 }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "instances": { "description": "List of all app instances.", "items": { "$ref": "#/components/schemas/AppInstance" }, "maxItems": 500, "minItems": 0, "type": "array" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "instances", "limit" ], "type": "object" }, "AppInstanceStatusDetails": { "description": "The status of the pod and it's containers", "properties": { "restarts": { "description": "The number of restarts of the app instance.", "example": 4, "format": "int64", "maximum": 999, "minimum": 0, "readOnly": true, "type": "integer" }, "system_container": { "$ref": "#/components/schemas/ContainerStatus" }, "user_container": { "$ref": "#/components/schemas/ContainerStatus" } }, "required": [ "restarts" ], "type": "object" }, "AppList": { "description": "Contains a list of apps and pagination information.", "example": { "apps": [ { "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "endpoint_internal": "http://my-app.uyh5shf7s0f.svc.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app", "id": "230828b4-4f15-40a9-b183-1268c6ab88d5", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "managed_domain_mappings": "local_public", "name": "my-app", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" } ], "limit": 50 }, "properties": { "apps": { "description": "List of all apps.", "items": { "$ref": "#/components/schemas/App" }, "maxItems": 500, "minItems": 0, "type": "array" }, "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "apps", "limit" ], "type": "object" }, "AppPatch": { "description": "App is the request model for app update operations.", "example": { "image_reference": "icr.io/codeengine/hello" }, "properties": { "image_port": { "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", "example": 8080, "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "image_reference": { "description": "The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "managed_domain_mappings": { "description": "Optional value controlling which of the system managed domain mappings will be setup for the application.\nValid values are 'local_public', 'local_private' and 'local'.\nVisibility can only be 'local_private' if the project supports application private visibility.", "enum": [ "local", "local_private", "local_public" ], "example": "local_public", "type": "string" }, "probe_liveness": { "$ref": "#/components/schemas/ProbePrototype" }, "probe_readiness": { "$ref": "#/components/schemas/ProbePrototype" }, "run_arguments": { "description": "Optional arguments for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "Optional user ID (UID) to run the app.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Optional commands for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_service_account": { "description": "Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Optional mounts of config maps or a secrets. In case this is provided, existing `run_volume_mounts` will be overwritten.", "items": { "$ref": "#/components/schemas/VolumeMountPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_concurrency": { "description": "Optional maximum number of requests that can be processed concurrently per instance.", "example": 100, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_concurrency_target": { "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created.\nUse this value to scale up instances based on concurrent number of requests.\nThis option defaults to the value of the `scale_concurrency` option, if not specified.", "example": 80, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_cpu_limit": { "description": "Optional number of CPU set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": 0, "description": "Optional amount of time in seconds that delays the scale-down behavior for an app instance.", "example": 300, "format": "int64", "maximum": 3600, "minimum": 0, "type": "integer" }, "scale_ephemeral_storage_limit": { "description": "Optional amount of ephemeral storage to set for the instance of the app.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_initial_instances": { "description": "Optional initial number of instances that are created upon app creation or app update.", "example": 1, "format": "int64", "type": "integer" }, "scale_max_instances": { "description": "Optional maximum number of instances for this app.\nIf you set this value to `0`, this property does not set a upper scaling limit.\nHowever, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", "example": 10, "format": "int64", "type": "integer" }, "scale_memory_limit": { "description": "Optional amount of memory set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_min_instances": { "default": 0, "description": "Optional minimum number of instances for this app.\nIf you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", "example": 1, "format": "int64", "type": "integer" }, "scale_request_timeout": { "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", "example": 300, "format": "int64", "type": "integer" } }, "type": "object" }, "AppPrototype": { "description": "App is the request model for app create operations.", "example": { "image_reference": "icr.io/codeengine/helloworld", "name": "my-app" }, "properties": { "image_port": { "default": 8080, "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", "example": 8080, "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "image_reference": { "description": "The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "managed_domain_mappings": { "default": "local_public", "description": "Optional value controlling which of the system managed domain mappings will be setup for the application.\nValid values are 'local_public', 'local_private' and 'local'.\nVisibility can only be 'local_private' if the project supports application private visibility.", "enum": [ "local", "local_private", "local_public" ], "example": "local_public", "type": "string" }, "name": { "description": "The name of the app. Use a name that is unique within the project.", "example": "my-app", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "probe_liveness": { "$ref": "#/components/schemas/ProbePrototype" }, "probe_readiness": { "$ref": "#/components/schemas/ProbePrototype" }, "run_arguments": { "description": "Optional arguments for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "Optional user ID (UID) to run the app.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Optional commands for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values that are exposed as environment variables within the running application.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_service_account": { "default": "default", "description": "Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Optional mounts of config maps or a secrets.", "items": { "$ref": "#/components/schemas/VolumeMountPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_concurrency": { "default": 100, "description": "Optional maximum number of requests that can be processed concurrently per instance.", "example": 100, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_concurrency_target": { "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created.\nUse this value to scale up instances based on concurrent number of requests.\nThis option defaults to the value of the `scale_concurrency` option, if not specified.", "example": 80, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_cpu_limit": { "default": "1", "description": "Optional number of CPU set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": 0, "description": "Optional amount of time in seconds that delays the scale-down behavior for an app instance.", "example": 300, "format": "int64", "maximum": 3600, "minimum": 0, "type": "integer" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "Optional amount of ephemeral storage to set for the instance of the app.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_initial_instances": { "default": 1, "description": "Optional initial number of instances that are created upon app creation or app update.", "example": 1, "format": "int64", "type": "integer" }, "scale_max_instances": { "default": 10, "description": "Optional maximum number of instances for this app.\nIf you set this value to `0`, this property does not set a upper scaling limit.\nHowever, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", "example": 10, "format": "int64", "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_min_instances": { "default": 0, "description": "Optional minimum number of instances for this app.\nIf you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", "example": 1, "format": "int64", "type": "integer" }, "scale_request_timeout": { "default": 300, "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", "example": 300, "format": "int64", "type": "integer" } }, "required": [ "name", "image_reference" ], "type": "object" }, "AppRevision": { "description": "AppRevision is the response model for app revision resources.", "example": { "app_name": "my-app", "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/revisions/my-app-00001", "id": "b63b3e28-2c1b-4784-9cd6-18c201fc6806", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "name": "my-app-00001", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_revision_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" }, "properties": { "app_name": { "description": "Name of the associated app.", "example": "my-app", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "computed_env_variables": { "description": "References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "href": { "description": "When you provision a new revision, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/apps/my-app/revisions/my-app-00001", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "image_port": { "default": 8080, "description": "Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is used to connect to the port that is exposed by the container image.", "example": 8080, "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "image_reference": { "description": "The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "name": { "description": "The name of the app revision.", "example": "my-app-00001", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "readOnly": true, "type": "string" }, "probe_liveness": { "$ref": "#/components/schemas/Probe" }, "probe_readiness": { "$ref": "#/components/schemas/Probe" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the app revision.", "enum": [ "app_revision_v2" ], "readOnly": true, "type": "string" }, "run_arguments": { "description": "Optional arguments for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "Optional user ID (UID) to run the app.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Optional commands for the app that are passed to start the container.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "References to config maps, secrets or literal values, which are defined by the app owner and are exposed as environment variables in the application.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_service_account": { "default": "default", "description": "Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Mounts of config maps or secrets.", "items": { "$ref": "#/components/schemas/VolumeMount" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_concurrency": { "default": 100, "description": "Optional maximum number of requests that can be processed concurrently per instance.", "example": 100, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_concurrency_target": { "description": "Optional threshold of concurrent requests per instance at which one or more additional instances are created.\nUse this value to scale up instances based on concurrent number of requests.\nThis option defaults to the value of the `scale_concurrency` option, if not specified.", "example": 80, "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer" }, "scale_cpu_limit": { "default": "1", "description": "Optional number of CPU set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": 0, "description": "Optional amount of time in seconds that delays the scale-down behavior for an app instance.", "example": 300, "format": "int64", "maximum": 3600, "minimum": 0, "type": "integer" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "Optional amount of ephemeral storage to set for the instance of the app.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_initial_instances": { "default": 1, "description": "Optional initial number of instances that are created upon app creation or app update.", "example": 1, "format": "int64", "type": "integer" }, "scale_max_instances": { "default": 10, "description": "Optional maximum number of instances for this app.\nIf you set this value to `0`, this property does not set a upper scaling limit.\nHowever, the app scaling is still limited by the project quota for instances. See [Limits and quotas for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).", "example": 10, "format": "int64", "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the app.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_min_instances": { "default": 0, "description": "Optional minimum number of instances for this app.\nIf you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.", "example": 1, "format": "int64", "type": "integer" }, "scale_request_timeout": { "default": 300, "description": "Optional amount of time in seconds that is allowed for a running app to respond to a request.", "example": 300, "format": "int64", "type": "integer" }, "status": { "description": "The current status of the app revision.", "enum": [ "ready", "loading", "warning", "failed" ], "example": "ready", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/AppRevisionStatus" } }, "required": [ "computed_env_variables", "created_at", "id", "href", "image_reference", "project_id", "region", "name", "run_arguments", "run_commands", "run_env_variables", "run_service_account", "run_volume_mounts", "scale_cpu_limit", "scale_ephemeral_storage_limit", "scale_max_instances", "scale_memory_limit", "scale_min_instances", "scale_request_timeout", "status", "resource_type" ], "type": "object" }, "AppRevisionList": { "description": "Contains a list of app revisions and pagination information.", "example": { "limit": 50, "revisions": [ { "app_name": "my-app", "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/revisions/my-app-00001", "id": "b63b3e28-2c1b-4784-9cd6-18c201fc6806", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "name": "my-app-00001", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_revision_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" } ] }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" }, "revisions": { "description": "List of all app revisions.", "items": { "$ref": "#/components/schemas/AppRevision" }, "maxItems": 500, "minItems": 0, "type": "array" } }, "required": [ "revisions", "limit" ], "type": "object" }, "AppRevisionStatus": { "description": "The detailed status of the application revision.", "example": { "actual_instances": 1, "reason": "ready" }, "properties": { "actual_instances": { "description": "The number of running instances of the revision.", "example": 1, "format": "int32", "readOnly": true, "type": "integer" }, "reason": { "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", "enum": [ "ready", "waiting", "deploying", "deploying_waiting_for_resources", "initial_scale_never_achieved", "fetch_image_failed_unknown_manifest", "fetch_image_failed_unknown_repository", "fetch_image_failed_registry_not_found", "fetch_image_failed_missing_pull_secret", "fetch_image_failed_wrong_pull_credentials", "fetch_image_failed_missing_pull_credentials", "container_failed_exit_code_0", "container_failed_exit_code_1", "container_failed_exit_code_139", "container_failed_exit_code_24", "image_pull_back_off", "invalid_tar_header_image_pull_err" ], "example": "ready", "readOnly": true, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "AppStatus": { "description": "The detailed status of the application.", "example": { "latest_created_revision": "my-app-00002", "latest_ready_revision": "my-app-00001", "reason": "ready" }, "properties": { "latest_created_revision": { "description": "Latest app revision that has been created.", "example": "my-app-00001", "readOnly": true, "type": "string" }, "latest_ready_revision": { "description": "Latest app revision that reached a ready state.", "example": "my-app-00001", "readOnly": true, "type": "string" }, "reason": { "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", "enum": [ "ready", "deploying", "waiting_for_resources", "no_revision_ready", "ready_but_latest_revision_failed" ], "example": "ready", "readOnly": true, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "BasicAuthSecretData": { "example": { "password": "password", "username": "username" }, "properties": { "password": { "description": "Basic auth password", "maxLength": 253, "minLength": 1, "pattern": ".*$", "type": "string" }, "username": { "description": "Basic auth username", "maxLength": 253, "minLength": 1, "pattern": ".*$", "type": "string" } }, "required": [ "username", "password" ], "type": "object" }, "Binding": { "description": "Describes the model of a binding.", "example": { "component": { "name": "my-app-1", "resource_type": "app_v2" }, "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings/a172ced-b5f21bc-71ba50c-1638604", "id": "a172ced-b5f21bc-71ba50c-1638604", "prefix": "PREFIX", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "resource_type": "binding_v2", "secret_name": "my-service-access", "status": "active" }, "properties": { "component": { "$ref": "#/components/schemas/ComponentRef" }, "href": { "description": "When you provision a new binding, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/bindings/my-binding", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The ID of the binding.", "example": "a172ced-b5f21bc-71ba50c-1638604", "maxLength": 253, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" }, "prefix": { "description": "The value that is set as a prefix in the component that is bound.", "example": "MY_COS", "maxLength": 31, "minLength": 0, "pattern": "^[A-Z]([_A-Z0-9]*[A-Z0-9])*$", "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "resource_type": { "description": "The type of the binding.", "enum": [ "binding_v2" ], "readOnly": true, "type": "string" }, "secret_name": { "description": "The service access secret that is bound to a component.", "example": "my-service-access", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "status": { "description": "The current status of the binding.", "example": "active", "readOnly": true, "type": "string" } }, "required": [ "component", "href", "id", "prefix", "project_id", "resource_type", "secret_name" ], "type": "object", "x-data-source-name": "code_engine_binding", "x-data-source-operations": { "read": "get_binding" }, "x-resource-name": "code_engine_binding", "x-resource-operations": { "create": "create_binding", "delete": "delete_binding", "read": "get_binding" }, "x-terraform-timeouts": { "create": 20, "delete": 20 } }, "BindingList": { "description": "Contains a list of bindings and pagination information.", "example": { "bindings": [ { "component": { "name": "my-app-1", "resource_type": "app_v2" }, "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings/app_my-app-1_my-service-access_PREFIX", "id": "app_my-app-1_my-service-access_PREFIX", "prefix": "PREFIX", "project_id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "region": "us-east", "resource_type": "binding_v2", "secret_name": "my-service-access", "status": "active" } ], "limit": 50 }, "properties": { "bindings": { "description": "List of all bindings.", "items": { "$ref": "#/components/schemas/Binding" }, "maxItems": 500, "minItems": 0, "type": "array" }, "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "bindings", "limit" ], "type": "object" }, "BindingPrototype": { "description": "Describes the model to create a new binding.", "example": { "component": { "name": "my-app-1", "resource_type": "app_v2" }, "prefix": "PREFIX", "secret_name": "my-service-access" }, "properties": { "component": { "$ref": "#/components/schemas/ComponentRef" }, "prefix": { "description": "Optional value that is set as prefix in the component that is bound. Will be generated if not provided.", "example": "MY_COS", "maxLength": 31, "minLength": 0, "pattern": "^[A-Z]([_A-Z0-9]*[A-Z0-9])*$", "type": "string" }, "secret_name": { "description": "The service access secret that is bound to a component.", "example": "my-service-access", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "component", "prefix", "secret_name" ], "type": "object" }, "Build": { "description": "Response model for build definitions.", "example": { "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "my-build", "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "build_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "status": "ready", "strategy_size": "medium", "strategy_type": "dockerfile", "timeout": 600 }, "properties": { "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "entity_tag": { "description": "The version of the build instance, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "href": { "description": "When you provision a new build, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/builds/my-build", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the build.", "example": "my-build", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string", "x-terraform-force-new": true }, "output_image": { "description": "The name of the image.", "example": "private.de.icr.io/icr_namespace/image-name", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "output_secret": { "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", "example": "ce-auto-icr-private-eu-de", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the build.", "enum": [ "build_v2" ], "readOnly": true, "type": "string" }, "run_build_params": { "description": "References to config maps and secret keys, or literal values, which are defined by the build owner and are exposed as build arguments in Docker files.", "items": { "$ref": "#/components/schemas/BuildParam" }, "maxItems": 100, "minItems": 0, "type": "array" }, "source_context_dir": { "description": "Optional directory in the repository that contains the buildpacks file or the Dockerfile.", "example": "some/subfolder", "maxLength": 253, "minLength": 0, "pattern": "^(.*)+$", "type": "string" }, "source_revision": { "description": "Commit, tag, or branch in the source repository to pull.\nThis field is optional if the `source_type` is `git` and uses the HEAD of default branch if not specified.\nIf the `source_type` value is `local`, this field must be omitted.", "example": "main", "maxLength": 253, "minLength": 0, "pattern": "^[\\S]*$", "type": "string" }, "source_secret": { "description": "Name of the secret that is used access the repository source.\nThis field is optional if the `source_type` is `git`. Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too.\nIf the `source_type` value is `local`, this field must be omitted.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "source_type": { "default": "git", "description": "Specifies the type of source to determine if your build source is in a repository or based on local source code.\n* local - For builds from local source code.\n* git - For builds from git version controlled source code.", "enum": [ "local", "git" ], "example": "git", "type": "string" }, "source_url": { "description": "The URL of the code repository. This field is required if the `source_type` is `git`.\nIf the `source_type` value is `local`, this field must be omitted.\nIf the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`.\nIf the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", "example": "https://github.com/IBM/CodeEngine", "maxLength": 253, "minLength": 1, "pattern": "^((https:\\/\\/[a-z0-9]([\\-.]?[a-z0-9])+(:\\d{1,5})?)|((ssh:\\/\\/)?git@[a-z0-9]([\\-.]{0,1}[a-z0-9])+(:[a-zA-Z0-9\\/][\\w\\-.]*)?))(\\/([\\w\\-.]|%20)+)*$", "type": "string" }, "status": { "description": "The current status of the build.", "enum": [ "ready", "failed" ], "example": "ready", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/BuildStatus" }, "strategy_size": { "default": "medium", "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`, `xxlarge`.", "enum": [ "small", "medium", "large", "xlarge", "xxlarge" ], "example": "medium", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "strategy_spec_file": { "description": "Optional path to the specification file that is used for build strategies for building an image.", "example": "Dockerfile", "maxLength": 253, "minLength": 1, "pattern": "^[\\S]*$", "type": "string" }, "strategy_type": { "default": "dockerfile", "description": "The strategy to use for building the image.", "enum": [ "dockerfile", "buildpacks" ], "example": "dockerfile", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "timeout": { "default": 600, "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", "example": 600, "format": "int32", "maximum": 3600, "minimum": 1, "type": "integer" } }, "required": [ "created_at", "entity_tag", "id", "project_id", "region", "output_image", "output_secret", "resource_type", "run_build_params", "source_type", "status", "strategy_type", "strategy_size" ], "type": "object", "x-data-source-name": "code_engine_build", "x-data-source-operations": { "read": "get_build" }, "x-resource-name": "code_engine_build", "x-resource-operations": { "create": "create_build", "delete": "delete_build", "read": "get_build", "update": "update_build" } }, "BuildList": { "description": "Contains a list of builds and pagination information.", "example": { "builds": [ { "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "my-build", "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "build_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "status": "ready", "strategy_size": "medium", "strategy_type": "dockerfile", "timeout": 600 } ], "limit": 50 }, "properties": { "builds": { "description": "List of all builds.", "items": { "$ref": "#/components/schemas/Build" }, "maxItems": 500, "minItems": 0, "type": "array" }, "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "builds", "limit" ], "type": "object" }, "BuildParam": { "description": "Response model for build params.", "example": { "name": "var-name", "type": "literal", "value": "some-value" }, "properties": { "key": { "description": "The key to reference as build param.", "example": "MY_VARIABLE", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z][\\-._a-zA-Z0-9]*$", "type": "string" }, "name": { "description": "The name of the build param.", "example": "SOME", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z][\\-._a-zA-Z0-9]*$", "type": "string" }, "reference": { "description": "The name of the secret or config map.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "type": { "default": "literal", "description": "Specify the type of the build param.", "enum": [ "literal", "config_map_key_reference", "secret_key_reference" ], "example": "literal", "pattern": "^(literal|config_map_key_reference|secret_key_reference)$", "type": "string" }, "value": { "description": "The literal value of the build param.", "example": "VALUE", "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" } }, "required": [ "type" ], "type": "object" }, "BuildParamPrototype": { "description": "Prototype model for build params.", "example": { "name": "var-name", "type": "literal", "value": "some-value" }, "properties": { "key": { "description": "The key to reference as build param.", "example": "MY_VARIABLE", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z][\\-._a-zA-Z0-9]*$", "type": "string" }, "name": { "description": "The name of the build param.", "example": "SOME", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z][\\-._a-zA-Z0-9]*$", "type": "string" }, "reference": { "description": "The name of the secret or config map.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "type": { "default": "literal", "description": "Specify the type of the build param.", "enum": [ "literal", "config_map_key_reference", "secret_key_reference" ], "example": "literal", "pattern": "^(literal|config_map_key_reference|secret_key_reference)$", "type": "string" }, "value": { "description": "The literal value of the build param.", "example": "VALUE", "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" } }, "required": [ "type" ], "type": "object" }, "BuildPatch": { "description": "Patch a build object.", "example": { "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "strategy_size": "large", "strategy_type": "dockerfile" }, "properties": { "output_image": { "description": "The name of the image.", "example": "private.de.icr.io/icr_namespace/image-name", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "output_secret": { "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", "example": "ce-auto-icr-private-eu-de", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "run_build_params": { "description": "Optional references to config maps and secret keys, or literal values that are exposed as build arguments within the Docker file.", "items": { "$ref": "#/components/schemas/BuildParamPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "source_context_dir": { "description": "Optional directory in the repository that contains the buildpacks file or the Dockerfile.", "example": "some/subfolder", "maxLength": 253, "minLength": 0, "pattern": "^(.*)+$", "type": "string" }, "source_revision": { "description": "Commit, tag, or branch in the source repository to pull.\nThis field is optional if the `source_type` is `git` and uses the HEAD of default branch if not specified.\nIf the `source_type` value is `local`, this field must be omitted.", "example": "main", "maxLength": 253, "minLength": 0, "pattern": "^[\\S]*$", "type": "string" }, "source_secret": { "description": "Name of the secret that is used access the repository source.\nThis field is optional if the `source_type` is `git`. Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too.\nIf the `source_type` value is `local`, this field must be omitted.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "source_type": { "description": "Specifies the type of source to determine if your build source is in a repository or based on local source code.\n* local - For builds from local source code.\n* git - For builds from git version controlled source code.", "enum": [ "local", "git" ], "example": "git", "type": "string" }, "source_url": { "description": "The URL of the code repository. This field is required if the `source_type` is `git`.\nIf the `source_type` value is `local`, this field must be omitted.\nIf the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`.\nIf the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", "example": "https://github.com/IBM/CodeEngine", "maxLength": 253, "minLength": 1, "pattern": "^((https:\\/\\/[a-z0-9]([\\-.]?[a-z0-9])+(:\\d{1,5})?)|((ssh:\\/\\/)?git@[a-z0-9]([\\-.]{0,1}[a-z0-9])+(:[a-zA-Z0-9\\/][\\w\\-.]*)?))(\\/([\\w\\-.]|%20)+)*$", "type": "string" }, "strategy_size": { "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`, `xxlarge`.", "enum": [ "small", "medium", "large", "xlarge", "xxlarge" ], "example": "medium", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "strategy_spec_file": { "description": "Optional path to the specification file that is used for build strategies for building an image.", "example": "Dockerfile", "maxLength": 253, "minLength": 1, "pattern": "^[\\S]*$", "type": "string" }, "strategy_type": { "description": "The strategy to use for building the image.", "enum": [ "dockerfile", "buildpacks" ], "example": "dockerfile", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "timeout": { "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", "example": 600, "format": "int32", "maximum": 3600, "minimum": 1, "type": "integer" } }, "type": "object" }, "BuildPrototype": { "description": "Prototype for build objects.", "example": { "name": "my-build", "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "strategy_size": "medium", "strategy_type": "dockerfile" }, "properties": { "name": { "description": "The name of the build. Use a name that is unique within the project.", "example": "my-build", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "output_image": { "description": "The name of the image.", "example": "private.de.icr.io/icr_namespace/image-name", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "output_secret": { "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", "example": "ce-auto-icr-private-eu-de", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "run_build_params": { "description": "Optional references to config maps and secret keys, or literal values that are exposed as build arguments within the Docker file.", "items": { "$ref": "#/components/schemas/BuildParamPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "source_context_dir": { "description": "Optional directory in the repository that contains the buildpacks file or the Dockerfile.", "example": "some/subfolder", "maxLength": 253, "minLength": 0, "pattern": "^(.*)+$", "type": "string" }, "source_revision": { "description": "Commit, tag, or branch in the source repository to pull.\nThis field is optional if the `source_type` is `git` and uses the HEAD of default branch if not specified.\nIf the `source_type` value is `local`, this field must be omitted.", "example": "main", "maxLength": 253, "minLength": 0, "pattern": "^[\\S]*$", "type": "string" }, "source_secret": { "description": "Name of the secret that is used access the repository source.\nThis field is optional if the `source_type` is `git`. Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too.\nIf the `source_type` value is `local`, this field must be omitted.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "source_type": { "default": "git", "description": "Specifies the type of source to determine if your build source is in a repository or based on local source code.\n* local - For builds from local source code.\n* git - For builds from git version controlled source code.", "enum": [ "local", "git" ], "example": "git", "type": "string" }, "source_url": { "description": "The URL of the code repository. This field is required if the `source_type` is `git`.\nIf the `source_type` value is `local`, this field must be omitted.\nIf the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`.\nIf the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", "example": "https://github.com/IBM/CodeEngine", "maxLength": 253, "minLength": 1, "pattern": "^((https:\\/\\/[a-z0-9]([\\-.]?[a-z0-9])+(:\\d{1,5})?)|((ssh:\\/\\/)?git@[a-z0-9]([\\-.]{0,1}[a-z0-9])+(:[a-zA-Z0-9\\/][\\w\\-.]*)?))(\\/([\\w\\-.]|%20)+)*$", "type": "string" }, "strategy_size": { "default": "medium", "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`, `xxlarge`.", "enum": [ "small", "medium", "large", "xlarge", "xxlarge" ], "example": "medium", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "strategy_spec_file": { "description": "Optional path to the specification file that is used for build strategies for building an image.", "example": "Dockerfile", "maxLength": 253, "minLength": 1, "pattern": "^[\\S]*$", "type": "string" }, "strategy_type": { "default": "dockerfile", "description": "The strategy to use for building the image.", "enum": [ "dockerfile", "buildpacks" ], "example": "dockerfile", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "timeout": { "default": 600, "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", "example": 600, "format": "int32", "maximum": 3600, "minimum": 1, "type": "integer" } }, "required": [ "name", "output_image", "output_secret", "strategy_type" ], "type": "object" }, "BuildRun": { "description": "Response model for build run objects.", "example": { "build_name": "my-build", "created_at": "2022-06-20T10:10:00+02:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs/my-buildrun-1", "id": "ca151bf7-b1bf-4e18-a1cb-857329c2d097", "name": "my-buildrun-1", "project_id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "region": "us-east", "resource_type": "build_run_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "service_account": "default", "source_type": "git", "status": "succeeded", "strategy_size": "large", "strategy_type": "dockerfile" }, "properties": { "build_name": { "description": "Optional name of the build on which this build run is based on.\nIf specified, the build run will inherit the configuration of the referenced build.\nIf not specified, make sure to specify at least the fields `strategy_type`, `source_url`, `output_image` and `output_secret` to describe the build run.", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "href": { "description": "When you trigger a new build run, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/build_runs/my-build-run", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the build run.", "example": "my-build-run", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "output_image": { "description": "The name of the image.", "example": "private.de.icr.io/icr_namespace/image-name", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "output_secret": { "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", "example": "ce-auto-icr-private-eu-de", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the build run.", "enum": [ "build_run_v2" ], "readOnly": true, "type": "string" }, "run_build_params": { "description": "References to config maps and secret keys, or literal values, which are defined by the build owner and are exposed as build arguments in Docker files.", "items": { "$ref": "#/components/schemas/BuildParam" }, "maxItems": 100, "minItems": 0, "type": "array" }, "service_account": { "description": "Optional service account, which is used for resource control.", "enum": [ "default", "manager", "reader", "writer", "none" ], "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "source_context_dir": { "description": "Optional directory in the repository that contains the buildpacks file or the Dockerfile.", "example": "some/subfolder", "maxLength": 253, "minLength": 0, "pattern": "^(.*)+$", "type": "string" }, "source_revision": { "description": "Commit, tag, or branch in the source repository to pull.\nThis field is optional if the `source_type` is `git` and uses the HEAD of default branch if not specified.\nIf the `source_type` value is `local`, this field must be omitted.", "example": "main", "maxLength": 253, "minLength": 0, "pattern": "^[\\S]*$", "type": "string" }, "source_secret": { "description": "Name of the secret that is used access the repository source.\nThis field is optional if the `source_type` is `git`. Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too.\nIf the `source_type` value is `local`, this field must be omitted.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "source_type": { "default": "git", "description": "Specifies the type of source to determine if your build source is in a repository or based on local source code.\n* local - For builds from local source code.\n* git - For builds from git version controlled source code.", "enum": [ "local", "git" ], "example": "git", "type": "string" }, "source_url": { "description": "The URL of the code repository. This field is required if the `source_type` is `git`.\nIf the `source_type` value is `local`, this field must be omitted.\nIf the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`.\nIf the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", "example": "https://github.com/IBM/CodeEngine", "maxLength": 253, "minLength": 1, "pattern": "^((https:\\/\\/[a-z0-9]([\\-.]?[a-z0-9])+(:\\d{1,5})?)|((ssh:\\/\\/)?git@[a-z0-9]([\\-.]{0,1}[a-z0-9])+(:[a-zA-Z0-9\\/][\\w\\-.]*)?))(\\/([\\w\\-.]|%20)+)*$", "type": "string" }, "status": { "description": "The current status of the build run.", "enum": [ "succeeded", "running", "pending", "failed" ], "example": "succeeded", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/BuildRunStatus" }, "strategy_size": { "default": "medium", "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`, `xxlarge`.", "enum": [ "small", "medium", "large", "xlarge", "xxlarge" ], "example": "medium", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "strategy_spec_file": { "description": "Optional path to the specification file that is used for build strategies for building an image.", "example": "Dockerfile", "maxLength": 253, "minLength": 1, "pattern": "^[\\S]*$", "type": "string" }, "strategy_type": { "default": "dockerfile", "description": "The strategy to use for building the image.", "enum": [ "dockerfile", "buildpacks" ], "example": "dockerfile", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "timeout": { "default": 600, "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", "example": 600, "format": "int32", "maximum": 3600, "minimum": 1, "type": "integer" } }, "required": [ "build_name", "created_at", "id", "project_id", "region", "name", "resource_type", "run_build_params", "service_account", "source_type", "status", "strategy_size", "strategy_type" ], "type": "object" }, "BuildRunList": { "description": "Contains a list of build runs and pagination information.", "example": { "build_runs": [ { "build_name": "my-build", "created_at": "2022-06-20T10:10:00+02:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs/my-buildrun-1", "id": "ca151bf7-b1bf-4e18-a1cb-857329c2d097", "name": "my-buildrun-1", "project_id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "region": "us-east", "resource_type": "build_run_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "service_account": "default", "source_type": "git", "status": "succeeded", "strategy_size": "large", "strategy_type": "dockerfile" } ], "limit": 50 }, "properties": { "build_runs": { "description": "List of all build runs.", "items": { "$ref": "#/components/schemas/BuildRun" }, "maxItems": 500, "minItems": 0, "type": "array" }, "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "build_runs", "limit" ], "type": "object" }, "BuildRunPrototype": { "description": "Prototype for build run objects.", "example": { "build_name": "my-build", "name": "my-buildrun-1" }, "properties": { "build_name": { "description": "Optional name of the build on which this build run is based on.\nIf specified, the build run will inherit the configuration of the referenced build.\nIf not specified, make sure to specify at least the fields `strategy_type`, `source_url`, `output_image` and `output_secret` to describe the build run.", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "name": { "description": "Name of the build run. This field is optional, if the field `build_name` is specified and its value will be generated like so: `[BUILD_NAME]-run-[timestamp with format: YYMMDD-hhmmss] if not set.`", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "output_image": { "description": "The name of the image.", "example": "private.de.icr.io/icr_namespace/image-name", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "output_secret": { "description": "The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.", "example": "ce-auto-icr-private-eu-de", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "run_build_params": { "description": "Optional references to config maps and secret keys, or literal values that are exposed as build arguments within the Docker file.", "items": { "$ref": "#/components/schemas/BuildParamPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "service_account": { "description": "Optional service account, which is used for resource control.", "enum": [ "default", "manager", "reader", "writer", "none" ], "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "source_context_dir": { "description": "Optional directory in the repository that contains the buildpacks file or the Dockerfile.", "example": "some/subfolder", "maxLength": 253, "minLength": 0, "pattern": "^(.*)+$", "type": "string" }, "source_revision": { "description": "Commit, tag, or branch in the source repository to pull.\nThis field is optional if the `source_type` is `git` and uses the HEAD of default branch if not specified.\nIf the `source_type` value is `local`, this field must be omitted.", "example": "main", "maxLength": 253, "minLength": 0, "pattern": "^[\\S]*$", "type": "string" }, "source_secret": { "description": "Name of the secret that is used access the repository source.\nThis field is optional if the `source_type` is `git`. Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too.\nIf the `source_type` value is `local`, this field must be omitted.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "source_type": { "default": "git", "description": "Specifies the type of source to determine if your build source is in a repository or based on local source code.\n* local - For builds from local source code.\n* git - For builds from git version controlled source code.", "enum": [ "local", "git" ], "example": "git", "type": "string" }, "source_url": { "description": "The URL of the code repository. This field is required if the `source_type` is `git`.\nIf the `source_type` value is `local`, this field must be omitted.\nIf the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`.\nIf the repository requires authentication, you need to provide a 'ssh' URL like `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.", "example": "https://github.com/IBM/CodeEngine", "maxLength": 253, "minLength": 1, "pattern": "^((https:\\/\\/[a-z0-9]([\\-.]?[a-z0-9])+(:\\d{1,5})?)|((ssh:\\/\\/)?git@[a-z0-9]([\\-.]{0,1}[a-z0-9])+(:[a-zA-Z0-9\\/][\\w\\-.]*)?))(\\/([\\w\\-.]|%20)+)*$", "type": "string" }, "strategy_size": { "default": "medium", "description": "Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`, `xxlarge`.", "enum": [ "small", "medium", "large", "xlarge", "xxlarge" ], "example": "medium", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "strategy_spec_file": { "description": "Optional path to the specification file that is used for build strategies for building an image.", "example": "Dockerfile", "maxLength": 253, "minLength": 1, "pattern": "^[\\S]*$", "type": "string" }, "strategy_type": { "default": "dockerfile", "description": "The strategy to use for building the image.", "enum": [ "dockerfile", "buildpacks" ], "example": "dockerfile", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "timeout": { "default": 600, "description": "The maximum amount of time, in seconds, that can pass before the build must succeed or fail.", "example": 600, "format": "int32", "maximum": 3600, "minimum": 1, "type": "integer" } }, "type": "object" }, "BuildRunStatus": { "description": "Current status condition of a build run.", "properties": { "completion_time": { "description": "Time the build run completed.", "example": "2022-09-22T17:40:00Z", "readOnly": true, "type": "string" }, "git_branch_name": { "description": "The default branch name of the git source.", "example": "main", "readOnly": true, "type": "string" }, "git_commit_author": { "description": "The commit author of a git source.", "example": "John Doe", "readOnly": true, "type": "string" }, "git_commit_sha": { "description": "The commit sha of the git source.", "example": "9a3d845c629d2b4a6b271b1d526dfafc1e7d9511", "readOnly": true, "type": "string" }, "output_digest": { "description": "Describes the time the build run completed.", "example": "sha256:9a3d845c629d2b4a6b271b1d526dfafc1e7d9511f8863b43b5bb0483ef626384", "readOnly": true, "type": "string" }, "reason": { "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", "enum": [ "succeeded", "running", "pending", "failed_to_execute_build_run", "exceeded_ephemeral_storage", "missing_registry_access", "missing_code_repo_access", "missing_secrets", "unknown_strategy", "invalid_build_configuration", "pod_evicted_because_of_storage_quota_exceeds", "pod_evicted", "missing_task_run", "task_run_generation_failed", "build_not_found", "timeout", "failed" ], "example": "succeeded", "readOnly": true, "type": "string" }, "source_timestamp": { "description": "The timestamp of the source.", "example": "2022-09-22T17:34:00Z", "readOnly": true, "type": "string" }, "start_time": { "description": "Time the build run started.", "example": "2022-09-22T17:34:00Z", "readOnly": true, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "BuildStatus": { "description": "The detailed status of the build.", "properties": { "reason": { "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", "enum": [ "registered", "strategy_not_found", "cluster_build_strategy_not_found", "set_owner_reference_failed", "spec_source_secret_not_found", "spec_output_secret_ref_not_found", "spec_runtime_secret_ref_not_found", "multiple_secret_ref_not_found", "runtime_paths_can_not_be_empty", "remote_repository_unreachable", "failed" ], "example": "registered", "readOnly": true, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "CbrStatus": { "description": "Status of the Context-based-restriction configuration applicable for this project.", "properties": { "data_plane": { "$ref": "#/components/schemas/EnforcementStatus" } }, "required": [ "data_plane" ], "type": "object" }, "CidrBlockData": { "description": "Allowed outbound destination of type CIDR block.", "example": { "cidr_block": "192.168.3.0/24" }, "properties": { "cidr_block": { "description": "The IPv4 address range.", "maxLength": 18, "minLength": 9, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/(3[0-2]|[1-2][0-9]|[0-9]))$", "type": "string" } }, "required": [ "cidr_block" ], "type": "object" }, "CidrBlockDataPatch": { "description": "Update an allowed outbound destination by using a CIDR block.", "example": { "cidr_block": "192.168.3.0/24" }, "properties": { "cidr_block": { "description": "The IPv4 address range.", "maxLength": 18, "minLength": 9, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/(3[0-2]|[1-2][0-9]|[0-9]))$", "type": "string" } }, "type": "object" }, "CidrBlockDataPrototype": { "description": "Create an allowed outbound destination by using a CIDR block.", "example": { "cidr_block": "192.168.3.0/24" }, "properties": { "cidr_block": { "description": "The IPv4 address range.", "maxLength": 18, "minLength": 9, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/(3[0-2]|[1-2][0-9]|[0-9]))$", "type": "string" } }, "required": [ "cidr_block" ], "type": "object" }, "ComponentRef": { "description": "A reference to another component.", "example": { "name": "my-app-1", "resource_type": "app_v2" }, "properties": { "name": { "description": "The name of the referenced component.", "example": "my-app-1", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "resource_type": { "description": "The type of the referenced resource.", "example": "app_v2", "maxLength": 63, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "name", "resource_type" ], "type": "object" }, "ConfigMap": { "description": "Describes the model of a configmap.", "example": { "created_at": "2022-11-15T21:45:49+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386238209", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map", "id": "b8376985-d6df-43c5-8feb-194d45390bc8", "name": "my-config-map", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "config_map_v2" }, "properties": { "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "data": { "additionalProperties": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "description": "The key-value pair for the config map. Values must be specified in `KEY=VALUE` format.", "type": "object" }, "entity_tag": { "description": "The version of the config map instance, which is used to achieve optimistic locking.", "example": "2385407409", "type": "string" }, "href": { "description": "When you provision a new config map, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/config_maps/my-config-map", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the config map.", "example": "my-config-map", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string", "x-terraform-force-new": true }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the config map.", "enum": [ "config_map_v2" ], "readOnly": true, "type": "string" } }, "required": [ "created_at", "entity_tag", "id", "project_id", "region", "name", "resource_type" ], "type": "object", "x-data-source-name": "code_engine_config_map", "x-data-source-operations": { "read": "get_config_map" }, "x-resource-name": "code_engine_config_map", "x-resource-operations": { "create": "create_config_map", "delete": "delete_config_map", "read": "get_config_map", "update": "replace_config_map" } }, "ConfigMapList": { "description": "Contains a list of config maps and pagination information.", "example": { "config_maps": [ { "created_at": "2022-11-15T21:45:49+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386238209", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map", "id": "b8376985-d6df-43c5-8feb-194d45390bc8", "name": "my-config-map", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "config_map_v2" } ], "limit": 50 }, "properties": { "config_maps": { "description": "List of all config maps.", "items": { "$ref": "#/components/schemas/ConfigMap" }, "maxItems": 500, "minItems": 0, "type": "array" }, "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "config_maps", "limit" ], "type": "object" }, "ConfigMapPatch": { "description": "Property values for the Config map instance patch", "example": { "data": { "MY_PROPERTY": "OTHER" } }, "properties": { "data": { "additionalProperties": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "description": "The key-value pair for the config map. Values must be specified in `KEY=VALUE` format. Each `KEY` field must consist of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each `VALUE` field can consists of any character and must not be exceed a max length of 1048576 characters.", "type": "object" } }, "type": "object" }, "ConfigMapPrototype": { "description": "Property values for the new Config map resource instance", "example": { "data": { "MY_PROPERTY": "VALUE" }, "name": "my-config-map" }, "properties": { "data": { "additionalProperties": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "description": "The key-value pair for the config map. Values must be specified in `KEY=VALUE` format. Each `KEY` field must consist of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each `VALUE` field can consists of any character and must not be exceed a max length of 1048576 characters.", "type": "object" }, "name": { "description": "The name of the configmap. Use a name that is unique within the project.", "example": "my-config-map", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "name" ], "type": "object" }, "ContainerStatus": { "description": "The status of a container", "properties": { "current_state": { "$ref": "#/components/schemas/ContainerStatusDetails" }, "last_observed_state": { "$ref": "#/components/schemas/ContainerStatusDetails" } }, "type": "object" }, "ContainerStatusDetails": { "description": "Details of the observed container status", "properties": { "completed_at": { "description": "The time the container terminated. Only populated in an observed failure state.", "example": "2022-09-22T17:40:00Z", "readOnly": true, "type": "string" }, "container_status": { "description": "The status of the container.", "enum": [ "running", "pending", "terminated" ], "readOnly": true, "type": "string" }, "exit_code": { "description": "The exit code of the last termination of the container. Only populated in an observed failure state.", "example": 0, "format": "int32", "maximum": 255, "minimum": 0, "readOnly": true, "type": "integer" }, "reason": { "description": "The reason the container is not yet running or has failed. Only populated in non-running states.", "example": "some_error_reason", "readOnly": true, "type": "string" }, "started_at": { "description": "The time the container started.", "example": "2022-09-22T17:34:00Z", "readOnly": true, "type": "string" } }, "required": [ "container_status" ], "type": "object" }, "CosBucket": { "description": "Input for tasks based on a referenced prefix in an object storage instance.", "example": { "cos_bucket": { "persistent_data_store": "my-persistent-data-store", "sub_path": "/my/bucket/data/" } }, "properties": { "cos_bucket": { "$ref": "#/components/schemas/CosBucketData" } }, "required": [ "cos_bucket" ], "type": "object" }, "CosBucketData": { "description": "Input for tasks based on a referenced prefix in an object storage instance.", "properties": { "persistent_data_store": { "description": "Name of referenced persistent data store resource.", "example": "my-fleet-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "readOnly": true, "type": "string" }, "sub_path": { "description": "Optional object storage prefix to be used as an entry point.", "example": "/my/bucket/data/", "maxLength": 1000, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "persistent_data_store" ], "type": "object" }, "CosBucketPrototype": { "description": "Input for tasks based on a referenced prefix in an object storage instance.", "example": { "cos_bucket": { "persistent_data_store": "my-persistent-data-store", "sub_path": "/my/bucket/data/" } }, "properties": { "cos_bucket": { "$ref": "#/components/schemas/CosBucketData" } }, "required": [ "cos_bucket" ], "type": "object" }, "DomainMapping": { "description": "Response model for domain mapping definitions.", "example": { "cname_target": "custom.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "component": { "name": "my-app", "resource_type": "app_v2" }, "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "www.example.com", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "domain_mapping_v2", "status": "ready", "tls_secret": "my-tls-secret", "user_managed": true, "visibility": "custom" }, "properties": { "cname_target": { "description": "The value of the CNAME record that must be configured in the DNS settings of the domain, to route traffic properly to the target Code Engine region.", "example": "custom.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "component": { "$ref": "#/components/schemas/ComponentRef" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "entity_tag": { "description": "The version of the domain mapping instance, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "href": { "description": "When you provision a new domain mapping, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/domain_mappings/www.example.com", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the domain mapping.", "example": "www.example.com", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)+$", "type": "string", "x-terraform-force-new": true }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the Code Engine resource.", "enum": [ "domain_mapping_v2" ], "readOnly": true, "type": "string" }, "status": { "description": "The current status of the domain mapping.", "enum": [ "ready", "failed", "deploying" ], "example": "ready", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/DomainMappingStatus" }, "tls_secret": { "description": "The name of the TLS secret that includes the certificate and private key of this domain mapping.", "example": "my-tls-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "user_managed": { "description": "Specifies whether the domain mapping is managed by the user or by Code Engine.", "readOnly": true, "type": "boolean" }, "visibility": { "description": "Specifies whether the domain mapping is reachable through the public internet, or private IBM network, or only through other components within the same Code Engine project.", "enum": [ "custom", "private", "project", "public" ], "example": "public", "readOnly": true, "type": "string" } }, "required": [ "component", "cname_target", "created_at", "entity_tag", "href", "id", "name", "project_id", "region", "resource_type", "status", "tls_secret", "user_managed", "visibility" ], "type": "object", "x-data-source-name": "code_engine_domain_mapping", "x-data-source-operations": { "read": "get_domain_mapping" }, "x-resource-name": "code_engine_domain_mapping", "x-resource-operations": { "create": "create_domain_mapping", "delete": "delete_domain_mapping", "read": "get_domain_mapping", "update": "update_domain_mapping" }, "x-terraform-timeouts": { "create": 10, "delete": 10, "update": 10 } }, "DomainMappingList": { "description": "Contains a list of domain mappings and pagination information.", "example": { "domain_mappings": [ { "cname_target": "custom.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "component": { "name": "my-app", "resource_type": "app_v2" }, "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "www.example.com", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "domain_mapping_v2", "status": "ready", "tls_secret": "my-tls-secret", "user_managed": true, "visibility": "custom" } ], "limit": 50 }, "properties": { "domain_mappings": { "description": "List of all domain mappings.", "items": { "$ref": "#/components/schemas/DomainMapping" }, "maxItems": 500, "minItems": 0, "type": "array" }, "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "domain_mappings", "limit" ], "type": "object" }, "DomainMappingPatch": { "description": "Patch a domain mappings object.", "example": { "component": { "name": "my-app", "resource_type": "app_v2" }, "tls_secret": "my-tls-secret" }, "properties": { "component": { "$ref": "#/components/schemas/ComponentRef" }, "tls_secret": { "description": "The name of the TLS secret that includes the certificate and private key of this domain mapping.", "example": "my-tls-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "type": "object" }, "DomainMappingPrototype": { "description": "Prototype for domain mapping objects.", "example": { "component": { "name": "my-app", "resource_type": "app_v2" }, "name": "www.example.com", "tls_secret": "my-tls-secret" }, "properties": { "component": { "$ref": "#/components/schemas/ComponentRef" }, "name": { "description": "The name of the domain mapping.", "example": "www.example.com", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)+$", "type": "string" }, "tls_secret": { "description": "The name of the TLS secret that includes the certificate and private key of this domain mapping.", "example": "my-tls-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "name", "component", "tls_secret" ], "type": "object" }, "DomainMappingStatus": { "description": "The detailed status of the domain mapping.", "properties": { "reason": { "description": "Optional information to provide more context in case of a 'failed' or 'warning' status.", "enum": [ "ready", "domain_already_claimed", "app_ref_failed", "failed_reconcile_ingress", "deploying", "failed" ], "example": "ready", "readOnly": true, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "EndpointGatewayDetails": { "description": "Optional information about the endpoint gateway located in the Code Engine VPC that connects to the private path service gateway", "properties": { "account_id": { "description": "The ID of the account that created the endpoint gateway, e.g. 4329073d16d2f3663f74bfa955259139.", "example": "4329073d16d2f3663f74bfa955259139", "readOnly": true, "type": "string" }, "created_at": { "description": "The timestamp when the endpoint gateway was created.", "example": "2025-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "ips": { "description": "The reserved IPs bound to this endpoint gateway.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "name": { "description": "The name for this endpoint gateway. The name is unique across all endpoint gateways in the VPC.", "example": "my-endpoint-gateway", "readOnly": true, "type": "string" } }, "required": [ "account_id", "created_at", "ips", "name" ], "type": "object" }, "EnforcementStatus": { "description": "Describes the model of the CBR enforcement status.", "properties": { "enforcement": { "description": "Detailed information on the condition of the CBR enforcement.", "enum": [ "applied", "out_of_sync", "none", "unknown" ], "type": "string" }, "inbound_private": { "description": "Indicates whether the private dataplane access to the project is blocked, partially_restricted, or allowed.", "enum": [ "blocked", "partially_restricted", "allowed", "unknown" ], "type": "string" }, "inbound_public": { "description": "Indicates whether the public dataplane access to the project is blocked or allowed.", "enum": [ "blocked", "allowed", "unknown" ], "type": "string" }, "last_synced_at": { "description": "Date time information specifying when the last synchronization happened.", "type": "string" } }, "required": [ "enforcement", "inbound_private", "inbound_public" ], "type": "object" }, "EnvVar": { "description": "Response model for environment variables.", "example": { "name": "var-name", "type": "literal", "value": "some-value" }, "properties": { "key": { "description": "The key to reference as environment variable.", "example": "MY_VARIABLE", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z0-9]+$", "type": "string" }, "name": { "description": "The name of the environment variable.", "example": "SOME", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z0-9]+$", "type": "string" }, "prefix": { "description": "A prefix that can be added to all keys of a full secret or config map reference.", "example": "PREFIX_", "maxLength": 253, "minLength": 0, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "reference": { "description": "The name of the secret or config map.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "type": { "default": "literal", "description": "Specify the type of the environment variable.", "enum": [ "literal", "config_map_full_reference", "secret_full_reference", "config_map_key_reference", "secret_key_reference" ], "example": "literal", "pattern": "^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$", "type": "string" }, "value": { "description": "The literal value of the environment variable.", "example": "VALUE", "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" } }, "required": [ "type" ], "type": "object" }, "EnvVarPrototype": { "description": "Prototype model for environment variables.", "example": { "name": "var-name", "type": "literal", "value": "some-value" }, "properties": { "key": { "description": "The key to reference as environment variable.", "example": "MY_VARIABLE", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z0-9]+$", "type": "string" }, "name": { "description": "The name of the environment variable.", "example": "SOME", "maxLength": 253, "minLength": 1, "pattern": "^[\\-._a-zA-Z0-9]+$", "type": "string" }, "prefix": { "description": "A prefix that can be added to all keys of a full secret or config map reference.", "example": "PREFIX_", "maxLength": 253, "minLength": 0, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "reference": { "description": "The name of the secret or config map.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "type": { "default": "literal", "description": "Specify the type of the environment variable.", "enum": [ "literal", "config_map_full_reference", "secret_full_reference", "config_map_key_reference", "secret_key_reference" ], "example": "literal", "pattern": "^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$", "type": "string" }, "value": { "description": "The literal value of the environment variable.", "example": "VALUE", "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" } }, "type": "object" }, "ErrorDetails": { "description": "ErrorDetails", "example": { "code": "unauthorized", "message": "A meaningful explanation" }, "properties": { "code": { "description": "Contains a snake case string succinctly identifying the problem.", "enum": [ "allowed_outbound_destination_cidrblock_not_set", "allowed_outbound_destination_cidr_overlapping", "allowed_outbound_destination_egress_rules_overlapping", "allowed_outbound_destination_already_exists", "allowed_outbound_destination_forbidden_iprange", "allowed_outbound_destination_iprange_already_exists", "allowed_outbound_destination_invalid_cidr_format", "allowed_outbound_destination_not_found", "allowed_outbound_destination_conflict_update", "allowed_outbound_destination_update_not_supported", "resource_already_exists", "iam_apikey_creation_forbidden", "api_key_not_found", "app_not_found", "app_conflict_update", "missing_malformed_auth", "binding_policy_init_forbidden", "binding_ce_services_not_found", "binding_conflict_exists", "binding_conflict_prefix_exists", "binding_apikey_init_forbidden", "binding_error_creating_service_id", "binding_init_failed", "binding_serviceid_init_forbidden", "binding_invalid_serviceid_crn", "binding_missing_resource_key_credentials", "binding_no_permission", "binding_not_found", "binding_resourceid_missmatch", "binding_error_resource_instance_inactive", "binding_resource_key_id_not_found", "build_attachment_invalid", "build_attachment_not_allowed", "build_owner_ref_resource_not_found", "build_owner_ref_invalid", "build_pack_strategy_and_build_params", "build_not_found", "build_source_credentials_unavailable", "build_source_reading_failed", "build_sources_upload_failed", "build_sources_credentials_not_found", "build_sources_credentials_wrong_type", "build_sources_too_large", "build_conflict_update", "code_bundle_too_large", "config_map_conflict_update", "container_registry_policy_init_forbidden", "container_registry_insufficient_iam_permission", "container_registry_auth_invalid", "container_registry_apikey_init_forbidden", "container_registry_serviceid_init_forbidden", "container_registry_namespace_access_forbidden", "container_registry_namespace_storage_quota_exceeded", "container_registry_namespace_requests_too_many", "code_cos_access_forbidden", "bucket_not_found", "eventing_path_wrong_destination", "code_cos_invalid_hmac_credentials", "cron_eventing_data_and_data_base64", "dedicated_service_gateway_conflict", "domain_mapping_invalid_component_type", "domain_mapping_conflict_update", "fleet_duplicate_entry", "volume_duplicate_volume_mountpath", "eventing_path_wrong_destination_resource_type", "field_invalid", "field_invalid_image_ref_not_supported", "field_invalid_image_ref_private_icr_endpoint_required", "field_invalid_output_image_invalid", "field_invalid_secret_ref_must_not_be_empty_for_non_icr_registries", "field_missing", "filter_bad_request", "filter_forbidden", "filter_invalid", "filter_not_found", "fleet_already_canceled", "fleet_deleting", "fleet_preferred_worker_profile_too_small", "fleet_resource_already_modified", "fleet_resource_gone", "fleet_resource_name_conflict", "fleet_resource_not_found", "fleet_task_not_found", "fleet_task_store_add_tasks_not_supported", "fleet_unsupported_worker_profile", "fleet_worker_cancel_conflict", "fleet_worker_cancel_not_allowed", "forbidden", "function_build_conflict_update", "function_not_found", "function_conflict_update", "header_invalid", "code_hmac_secret_still_in_use_issue", "user_ip_not_authorized", "cbr_resource_restriction_failed", "cbr_resource_restriction_fetch_failed", "cbr_resource_restriction_fetch_failed_invalid_account", "cbr_resource_restriction_fetch_failed_invalid_crn", "cbr_resource_restriction_fetch_failed_invalid_token", "iam_context_extraction_failed", "iam_policy_creation_forbidden", "iam_serviceid_creation_forbidden", "iam_not_authorized", "iam_token_extraction_error", "image_reference_missing", "inline_code_too_large", "internal", "yaml_conversion_failed", "volume_mount_path_invalid", "job_not_found", "job_spec_template_exceeds_limit", "job_conflict_update", "kube_project_bad_request", "kube_project_forbidden", "kube_project_invalid", "kube_project_not_found", "method_not_allowed", "default_resource_group_missing_viewer_permissions", "no_resource_controller_for_plan", "resource_not_found", "not_found", "one_time_service_credential_no_reuse", "operator_secret_not_found", "parameter_invalid", "code_persistent_storage_cos_internal_error", "code_persistent_storage_not_found_error", "code_persistent_storage_still_in_use", "private_path_service_crn_invalid", "private_path_service_gateway_wrong_account", "private_path_service_gateway_wrong_region", "project_already_exists", "project_already_exists_pending_reclamation", "project_disabled", "project_info_not_found", "project_internal", "project_not_found", "project_not_found_in_region", "project_not_ready", "project_settings_conflict_update", "project_unauthorized", "project_unavailable", "query_parameter_invalid", "query_parameter_not_supported", "quota_conflict", "quota_exceeded", "resource_controller_database_retry", "registry_conflict_secret_of_different_type_exists", "registry_secret_not_found", "registry_region_invalid", "registry_server_to_imageref_missmatch", "registry_type_not_supported", "request_entity_too_large", "request_invalid", "request_unparseable", "requests_too_many", "service_credential_quota_exceeded", "resource_controller_deletion_failed", "resource_controller_missing_editor_permissions", "resource_controller_missing_permissions", "resource_controller_missing_viewer_permissions", "resource_controller_requests_too_many", "resource_controller_requires_paid_account", "resource_controller_resource_key_deletion_failed", "resource_controller_ssl_handshake_failed", "resource_instance_invalid", "resource_key_quota_exceeded", "scc_project_location_violation", "secret_wrong_type", "secret_not_found", "secret_type_not_supported", "secret_conflict_update", "service_access_conflict_exists", "service_access_missing_permissions_role", "service_gateway_already_exists", "service_gateway_already_shared", "dedicated_service_gateway_exists", "service_gateway_invalid", "service_gateway_not_ready", "signing_outbound_context_failed", "subnet_crn_not_unique", "timeout", "tls_cert_decoding_failed", "tls_cert_dns_names_missing", "tls_cert_expired", "tls_cert_incompatible", "tls_cert_key_dont_match", "tls_cert_key_verification_error", "tls_cert_not_trusted", "tls_cert_parsing_failed", "tls_cert_revoked", "tls_cert_type_not_supported", "tls_cert_verify_hostname_failed", "tls_ecdsa_curve_not_supported", "tls_key_decoding_failed", "tls_key_parsing_failed", "tls_key_type_not_supported", "tls_cert_intermediate_certs_missing", "tls_secret_cert_invalid_hostname", "code_tls_secret_cert_key_mismatch", "tls_secret_cert_not_decodable", "tls_secret_cert_not_parsable", "tls_secret_key_not_decodable", "tls_secret_not_found", "code_tls_secret_still_in_use_issue", "tls_cert_self_signed_not_supported", "token_expired", "token_invalid", "token_unparseable", "token_wrong_clientid", "unauthorized", "unhandled", "service_access_update_not_allowed", "volume_mount_name_not_supported", "volume_mount_read_only_not_supported", "volume_mount_subpath_not_supported", "volume_mount_type_and_read_only", "volume_mount_type_persistent_data_store_not_supported", "project_operation_not_allowed", "spec_too_large", "subnet_crn_invalid", "subnet_crn_invalid_account", "subnet_crn_invalid_region" ], "type": "string" }, "message": { "description": "Contains a plainly-written, developer-oriented explanation of the solution to the problem in complete, well-formed sentences.", "type": "string" }, "more_info": { "description": "Optional field that contain a publicly-accessible URL where information about the error can be read in a web browser.", "type": "string" }, "target": { "$ref": "#/components/schemas/ErrorTarget" } }, "required": [ "code", "message" ], "type": "object" }, "ErrorResponse": { "description": "Describes an error response", "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "properties": { "errors": { "description": "Contains an array with at least one error model.", "items": { "$ref": "#/components/schemas/ErrorDetails" }, "maxItems": 100, "minItems": 1, "type": "array" }, "status_code": { "description": "Status code used for the response.", "format": "int32", "maximum": 599, "minimum": 0, "type": "integer" }, "trace": { "description": "Lowercase UUID uniquely identifying the request", "type": "string" } }, "required": [ "errors", "status_code", "trace" ], "type": "object" }, "ErrorTarget": { "description": "ErrorTarget", "example": { "name": "name", "reason": "REGEXP", "type": "field" }, "properties": { "name": { "description": "Contain the name of the problematic field (with dot-syntax if necessary), query parameter, or header", "type": "string" }, "reason": { "description": "Reason field, e.g. \"EMPTY\", \"REGEXP\", ...", "type": "string" }, "type": { "description": "Is either \"field\", \"parameter\", or \"header\".", "enum": [ "field", "parameter", "header" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "Fleet": { "description": "Fleet is the response model for fleet resources.", "example": { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30", "id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "image_reference": "icr.io/codeengine/helloworld", "image_secret": "my-access-secret", "name": "my-fleet-123", "network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_v2", "run_arguments": [], "run_commands": [], "run_env_variables": [], "run_volume_mounts": [], "scale_cpu_limit": "4", "scale_gpu_limit": 1, "scale_max_execution_time": "2h30m", "scale_max_instances": 10, "scale_memory_limit": "16G", "scale_retry_limit": 3, "scale_worker_profile": "gx2-8x64x1v100", "status": "running", "status_details": { "task_progress": { "canceled": 0, "failed": 0, "pending": 45, "running": 42, "succeeded": 13 } }, "tasks_specification": { "indices": "0-99" }, "tasks_state_store": { "persistent_data_store": "my-persistent-storage", "sub_path": "/my/bucket/data" } }, "properties": { "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "finished_at": { "description": "The timestamp when the fleet finished.", "example": "2025-06-30T11:41:35+02:00", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "href": { "description": "URL identifying the location of the fleet.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/fleets/e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "image_reference": { "description": "The name of the image that is used for this fleet.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "readOnly": true, "type": "string" }, "image_secret": { "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the fleet will not be able to process tasks.", "example": "my-access-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the fleet.", "example": "my-fleet", "maxLength": 63, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" }, "network_placements": { "description": "List of network locations determining in which network the workers and processed workload will be running.", "items": { "$ref": "#/components/schemas/NetworkPlacement" }, "maxItems": 100, "minItems": 1, "readOnly": true, "type": "array" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "maxLength": 63, "minLength": 5, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the fleet.", "enum": [ "fleet_v2" ], "readOnly": true, "type": "string" }, "run_arguments": { "description": "Optional arguments for the fleet that are passed to start the container.", "example": [ "arg1", "arg2" ], "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "readOnly": true, "type": "array" }, "run_commands": { "description": "Optional commands for the fleet that are passed to start the container.", "example": [ "my-cmd" ], "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "readOnly": true, "type": "array" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values that are exposed as environment variables within the running task process.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "readOnly": true, "type": "array" }, "run_volume_mounts": { "description": "Optional mounts of persistent data stores.", "items": { "$ref": "#/components/schemas/FleetVolumeMount" }, "maxItems": 100, "minItems": 0, "readOnly": true, "type": "array" }, "scale_cpu_limit": { "description": "Number of CPU set for each task in the fleet.", "example": "4", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "readOnly": true, "type": "string" }, "scale_down_delay": { "default": "0s", "description": "Optional amount of time that delays worker scale-down after task completion.", "example": "10m", "maxLength": 32, "minLength": 0, "pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$", "readOnly": true, "type": "string" }, "scale_gpu": { "$ref": "#/components/schemas/GPUScale" }, "scale_max_execution_time": { "description": "Optional maximum execution time in seconds of each tasks.", "example": "2h30m", "maxLength": 32, "minLength": 0, "pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$", "readOnly": true, "type": "string" }, "scale_max_instances": { "default": 10, "description": "Optional maximum number of instances for this fleet, determining how many task are processed simultaneously.", "example": 10, "format": "int32", "maximum": 10000, "minimum": 1, "readOnly": true, "type": "integer" }, "scale_memory_limit": { "description": "Amount of memory set for the instance of the fleet.", "example": "16G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "readOnly": true, "type": "string" }, "scale_min_instances": { "default": 0, "description": "Optional minimum worker capacity that is always retained for the fleet.", "example": 10, "format": "int32", "maximum": 10000, "minimum": 0, "readOnly": true, "type": "integer" }, "scale_preferred_worker_profile": { "description": "Optional worker profile name that will be used to provision a worker.\nThe fleet will fail if the profile is not available in the zones that are referenced as part of `locations`.", "example": "gx2-8x64x1v100", "maxLength": 64, "minLength": 0, "pattern": "^([a-z0-9]{3,5}-[0-9]+x[0-9]+(x[a-z0-9]+)?)$", "readOnly": true, "type": "string" }, "scale_retry_limit": { "default": 3, "description": "Optional number of times to rerun an instance of the task before the task is marked as failed.", "example": 3, "format": "int32", "maximum": 255, "minimum": 0, "readOnly": true, "type": "integer" }, "scale_spare_instances": { "default": 0, "description": "Optional spare worker capacity that is retained or created so that future tasks can start immediately.", "example": 5, "format": "int32", "maximum": 10000, "minimum": 0, "readOnly": true, "type": "integer" }, "status": { "description": "The current status of the fleet.", "enum": [ "canceled", "canceling", "deleting", "failed", "inoperative", "pending", "running", "standby", "successful", "suspended", "suspending" ], "example": "running", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/FleetStatusDetails" }, "tasks_specification": { "$ref": "#/components/schemas/TasksSpecification" }, "tasks_state_store": { "$ref": "#/components/schemas/TaskStateStore" } }, "required": [ "created_at", "href", "id", "image_reference", "name", "network_placements", "project_id", "region", "resource_type", "run_arguments", "run_commands", "run_env_variables", "run_volume_mounts", "scale_cpu_limit", "scale_max_instances", "scale_memory_limit", "scale_retry_limit", "status", "tasks_state_store" ], "type": "object" }, "FleetAddTasks": { "description": "FleetAddTasks contains the action ID for the add-tasks operation.", "example": { "id": "ab5eb341-2d55-4f85-9976-d6ae6e2f41fc" }, "properties": { "id": { "description": "The ID of the created action.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" } }, "required": [ "id" ], "type": "object" }, "FleetAddTasksPrototype": { "description": "FleetAddTasksPrototype is the request model for adding tasks to a fleet.", "example": { "batch_name": "my tasks", "tasks_specification": { "indices": "0-9" } }, "properties": { "batch_name": { "default": "default", "description": "Optional name for the batch of tasks being added.", "example": "tasks from 2026-06-01", "maxLength": 256, "minLength": 0, "pattern": "^[^/]*$", "type": "string" }, "tasks_specification": { "$ref": "#/components/schemas/TasksSpecificationPrototype" } }, "required": [ "tasks_specification" ], "type": "object" }, "FleetCancel": { "description": "FleetCancel is the request model for fleet cancelation operations.", "example": { "cancel_processing_tasks": true }, "properties": { "cancel_processing_tasks": { "default": false, "description": "Property determining if the fleet cancelation should immediately abort already running tasks, if so, set to `true`.", "example": true, "type": "boolean" } }, "type": "object" }, "FleetList": { "description": "Contains a list of fleets and pagination information.", "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets?limit=50" }, "fleets": [ { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30", "id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "image_reference": "icr.io/codeengine/helloworld", "image_secret": "my-access-secret", "name": "my-fleet-123", "network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_v2", "run_arguments": [], "run_commands": [], "run_env_variables": [], "run_volume_mounts": [], "scale_cpu_limit": "4", "scale_gpu_limit": 1, "scale_max_execution_time": "2h30m", "scale_max_instances": 10, "scale_memory_limit": "16G", "scale_retry_limit": 3, "scale_worker_profile": "gx2-8x64x1v100", "status": "running", "status_details": { "task_progress": { "canceled": 0, "failed": 0, "pending": 45, "running": 42, "succeeded": 13 } }, "tasks_specification": { "indices": "0-99" }, "tasks_state_store": { "persistent_data_store": "my-persistent-storage", "sub_path": "/my/bucket/data" } } ], "limit": 50, "next": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets?limit=50&start=eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ", "start": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ" } }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "fleets": { "description": "List of fleets.", "items": { "$ref": "#/components/schemas/Fleet" }, "maxItems": 500, "minItems": 0, "readOnly": true, "type": "array" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "fleets", "limit" ], "type": "object" }, "FleetPrototype": { "description": "FleetPrototype is the request model for fleet create operations.", "example": { "image_reference": "icr.io/codeengine/helloworld", "image_secret": "my-access-secret", "name": "my-fleet-123", "network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "scale_cpu_limit": "4", "scale_gpu_limit": 1, "scale_max_execution_time": "2h30m", "scale_max_instances": 10, "scale_memory_limit": "16G", "scale_worker_profile": "gx2-8x64x1v100", "tasks_specification": { "indices": "0-99" }, "tasks_state_store": { "persistent_data_store": "my-persistent-storage", "sub_path": "/my/bucket/data" } }, "properties": { "image_reference": { "description": "The name of the image that is used for this fleet.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the fleet will not be able to process tasks.", "example": "my-access-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "name": { "description": "The name of the fleet.", "example": "my-fleet", "maxLength": 63, "minLength": 1, "pattern": "^.+$", "type": "string" }, "network_placements": { "description": "List of network locations determining in which network the workers and processed workload will be running.", "items": { "$ref": "#/components/schemas/NetworkPlacementPrototype" }, "maxItems": 100, "minItems": 1, "type": "array" }, "run_arguments": { "description": "Optional arguments for the fleet that are passed to start the container.", "example": [ "arg1", "arg2" ], "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_commands": { "description": "Optional commands for the fleet that are passed to start the container.", "example": [ "my-cmd" ], "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values that are exposed as environment variables within the running task process.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_volume_mounts": { "description": "Optional mounts of persistent data stores.", "items": { "$ref": "#/components/schemas/FleetVolumeMountPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_cpu_limit": { "description": "Number of CPU set for each task in the fleet.", "example": "4", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": "0s", "description": "Optional amount of time that delays worker scale-down after task completion.", "example": "10m", "maxLength": 32, "minLength": 0, "pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$", "type": "string" }, "scale_gpu": { "$ref": "#/components/schemas/GPUScalePrototype" }, "scale_max_execution_time": { "description": "Optional maximum execution time of each attempt to process a task instance.", "example": "2h30m", "maxLength": 32, "minLength": 0, "pattern": "^([0-9]{1,5}(h|m|s|ms)){1,4}$", "type": "string" }, "scale_max_instances": { "default": 10, "description": "Optional maximum number of instances for this fleet, determining how many task are processed simultaneously.", "example": 10, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "description": "Amount of memory set for the instance of the fleet.", "example": "16G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_min_instances": { "default": 0, "description": "Optional minimum worker capacity that is always retained for the fleet.", "example": 10, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" }, "scale_preferred_worker_profile": { "description": "Optional worker profile name that will be used to provision a worker.\nThe fleet will fail if the profile is not available in the zones that are referenced as part of `connections`.", "example": "gx2-8x64x1v100", "maxLength": 64, "minLength": 0, "pattern": "^([a-z0-9]{3,5}-[0-9]+x[0-9]+(x[a-z0-9]+)?)$", "type": "string" }, "scale_retry_limit": { "default": 3, "description": "Optional number of times to rerun an instance of the task before the task is marked as failed.", "example": 3, "format": "int32", "maximum": 255, "minimum": 0, "type": "integer" }, "scale_spare_instances": { "default": 0, "description": "Optional spare worker capacity that is retained or created so that future tasks can start immediately.", "example": 5, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" }, "tasks_specification": { "$ref": "#/components/schemas/TasksSpecificationPrototype" }, "tasks_state_store": { "$ref": "#/components/schemas/TaskStateStorePrototype" } }, "required": [ "image_reference", "name", "network_placements", "scale_cpu_limit", "scale_max_instances", "scale_memory_limit", "tasks_state_store" ], "type": "object" }, "FleetStatusDetails": { "description": "The detailed status of the fleet.", "properties": { "reason": { "description": "Optional detailed reason why the fleet went into a failed state.", "example": "invalid_store_credentials", "maxLength": 63, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" }, "task_progress": { "$ref": "#/components/schemas/TaskProgress" } }, "required": [ "task_progress" ], "type": "object" }, "FleetVolumeMount": { "description": "List of mounted volumes in this fleet instance.", "example": { "mount_path": "/path", "reference": "my-persistent-data-store", "type": "persistent_data_store" }, "properties": { "mount_path": { "description": "The path that should be mounted.", "example": "/app", "maxLength": 256, "minLength": 1, "pattern": "^\\/([^\\/\\0]+\\/?)+$", "readOnly": true, "type": "string" }, "read_only": { "default": false, "description": "Optional flag to specify if the volume mount is read only.", "example": true, "readOnly": true, "type": "boolean" }, "reference": { "description": "The name of the referenced persistent data store.", "example": "my-persistent-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "readOnly": true, "type": "string" }, "sub_path": { "description": "The path mounted at the mount path.", "example": "some-path", "maxLength": 256, "minLength": 1, "pattern": "^([^\\/\\0]+\\/?)+$", "readOnly": true, "type": "string" }, "type": { "description": "Specify the type of the volume mount. Allowed types are: 'persistent_data_store'.", "enum": [ "persistent_data_store" ], "example": "persistent_data_store", "readOnly": true, "type": "string" } }, "required": [ "mount_path", "reference", "type" ], "type": "object" }, "FleetVolumeMountPrototype": { "description": "List of mounted volumes in this fleet instance.", "example": { "mount_path": "/path", "read_only": false, "reference": "my-persistent-data-store", "type": "persistent_data_store" }, "properties": { "mount_path": { "description": "The path that should be mounted.", "example": "/app", "maxLength": 256, "minLength": 1, "pattern": "^\\/([^\\/\\0]+\\/?)+$", "type": "string" }, "read_only": { "default": false, "description": "Optional flag to specify if the volume mount is read only.", "example": true, "type": "boolean" }, "reference": { "description": "The name of the referenced persistent data store.", "example": "my-persistent-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "sub_path": { "description": "The path mounted at the mount path.", "example": "some-path", "maxLength": 256, "minLength": 1, "pattern": "^([^\\/\\0]+\\/?)+$", "type": "string" }, "type": { "description": "Specify the type of the volume mount. Allowed types are: 'persistent_data_store'.", "enum": [ "persistent_data_store" ], "example": "persistent_data_store", "type": "string" } }, "required": [ "mount_path", "reference", "type" ], "type": "object" }, "Function": { "description": "Function is the response model for function resources", "example": { "code_binary": false, "code_reference": "data:text/plain;base64,", "computed_env_variables": [], "created_at": "2023-11-15T22:07:55Z", "endpoint": "https://my-function.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "endpoint_internal": "http://my-function.uyh5shf7s0f.function.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "managed_domain_mappings": "local_public", "name": "my-function", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "function_v2", "run_compute_resource_token_enabled": false, "run_env_variables": [], "runtime": "nodejs-24", "scale_concurrency": 1, "scale_cpu_limit": "0.5", "scale_down_delay": 0, "scale_max_execution_time": 60, "scale_memory_limit": "2G", "status": "ready", "status_details": { "reason": "ready" } }, "properties": { "code_binary": { "description": "Specifies whether the code is binary or not. Defaults to false when `code_reference` is set to a data URL.\nWhen `code_reference` is set to a code bundle URL, this field is always true.", "example": false, "type": "boolean" }, "code_main": { "default": "main", "description": "Specifies the name of the function that should be invoked.", "example": "main", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "code_reference": { "description": "Specifies either a reference to a code bundle or the source code itself.\nTo specify the source code, use the data URL scheme and include the source code as base64 encoded.\nThe data URL scheme is defined in [RFC 2397](https://tools.ietf.org/html/rfc2397).", "example": "data:text/plain;base64,", "maxLength": 1048576, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*", "type": "string" }, "code_secret": { "description": "The name of the secret that is used to access the specified `code_reference`.\nThe secret is used to authenticate with a non-public endpoint that is specified as`code_reference`.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "computed_env_variables": { "description": "References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the function.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "endpoint": { "description": "URL to invoke the function.", "example": "https://my-function.uyh5shf7s0f.eu-de.codeengine.appdomain.cloud", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "endpoint_internal": { "description": "URL to function that is only visible within the project.", "example": "http://my-function.uyh5shf7s0f.svc.cluster.local", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "entity_tag": { "description": "The version of the function instance, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "href": { "description": "When you provision a new function, a relative URL path is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/functions/my-function", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "managed_domain_mappings": { "default": "local_public", "description": "Optional value controlling which of the system managed domain mappings will be setup for the function.\nValid values are 'local_public', 'local_private' and 'local'.\nVisibility can only be 'local_private' if the project supports function private visibility.", "enum": [ "local", "local_private", "local_public" ], "example": "local_public", "type": "string" }, "name": { "description": "The name of the function.", "example": "my-function", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string", "x-terraform-force-new": true }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the function.", "enum": [ "function_v2" ], "readOnly": true, "type": "string" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "runtime": { "description": "The managed runtime used to execute the injected code.", "example": "nodejs-24", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]*\\-[0-9]*(\\.[0-9]*)?$", "type": "string" }, "scale_concurrency": { "default": 1, "description": "Number of parallel requests handled by a single instance, supported only by Node.js, default is `1`.", "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "scale_cpu_limit": { "default": "1", "description": "Optional amount of CPU set for the instance of the function.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": 1, "description": "Optional amount of time in seconds that delays the scale down behavior for a function.", "example": 300, "format": "int32", "maximum": 600, "minimum": 0, "type": "integer" }, "scale_max_execution_time": { "default": 60, "description": "Timeout in secs after which the function is terminated", "example": 60, "format": "int32", "maximum": 120, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the function.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "1G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "status": { "description": "The current status of the function.", "enum": [ "offline", "deploying", "ready", "failed" ], "example": "offline", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/FunctionStatus" } }, "required": [ "code_binary", "code_reference", "computed_env_variables", "created_at", "endpoint_internal", "entity_tag", "href", "id", "managed_domain_mappings", "name", "project_id", "region", "resource_type", "run_env_variables", "runtime", "scale_concurrency", "scale_cpu_limit", "scale_down_delay", "scale_max_execution_time", "scale_memory_limit", "status", "status_details" ], "type": "object", "x-data-source-name": "code_engine_function", "x-data-source-operations": { "read": "get_function" }, "x-resource-name": "code_engine_function", "x-resource-operations": { "create": "create_function", "delete": "delete_function", "read": "get_function", "update": "update_function" }, "x-terraform-timeouts": { "create": 10, "delete": 10, "update": 10 } }, "FunctionList": { "description": "Contains a list of functions and pagination information.", "example": { "functions": [ { "code_binary": true, "code_reference": "icr.io/codeengine/samples/function-nodejs-codebundle", "code_secret": "my-secret", "computed_env_variables": [ { "name": "CE_API_BASE_URL", "type": "literal", "value": "https://api.us-east.codeengine.cloud.ibm.com" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" }, { "name": "CE_FUNCTION", "type": "literal", "value": "my-function" }, { "name": "CE_REGION", "type": "literal", "value": "us-east" }, { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_PROJECT_ID", "type": "literal", "value": "15314cc3-85b4-4338-903f-c28cdee6d005" } ], "created_at": "2023-11-15T22:07:55Z", "endpoint": "https://my-function.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "endpoint_internal": "http://my-function.uyh5shf7s0f.function.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "managed_domain_mappings": "local_public", "name": "my-function", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "function_v2", "run_compute_resource_token_enabled": false, "run_env_variables": [], "runtime": "nodejs-24", "scale_concurrency": 1, "scale_cpu_limit": "0.5", "scale_down_delay": 0, "scale_max_execution_time": 60, "scale_memory_limit": "2G", "status": "ready", "status_details": { "reason": "ready" } } ], "limit": 50 }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "functions": { "description": "List of all functions.", "items": { "$ref": "#/components/schemas/Function" }, "maxItems": 500, "minItems": 0, "type": "array" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "functions", "limit" ], "type": "object" }, "FunctionPatch": { "description": "Request model for function update operations.", "example": { "code_reference": "icr.io/codeengine/samples/function-nodejs-codebundle", "code_secret": "my-secret", "scale_cpu_limit": "1", "scale_memory_limit": "4G" }, "properties": { "code_binary": { "description": "Specifies whether the code is binary or not. Defaults to false when `code_reference` is set to a data URL.\nWhen `code_reference` is set to a code bundle URL, this field is always true.", "example": false, "type": "boolean" }, "code_main": { "description": "Specifies the name of the function that should be invoked.", "example": "main", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "code_reference": { "description": "Specifies either a reference to a code bundle or the source code itself.\nTo specify the source code, use the data URL scheme and include the source code as base64 encoded.\nThe data URL scheme is defined in [RFC 2397](https://tools.ietf.org/html/rfc2397).", "example": "data:text/plain;base64,", "maxLength": 1048576, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*", "type": "string" }, "code_secret": { "description": "The name of the secret that is used to access the specified `code_reference`.\nThe secret is used to authenticate with a non-public endpoint that is specified as`code_reference`.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "managed_domain_mappings": { "description": "Optional value controlling which of the system managed domain mappings will be setup for the function.\nValid values are 'local_public', 'local_private' and 'local'.\nVisibility can only be 'local_private' if the project supports function private visibility.", "enum": [ "local", "local_private", "local_public" ], "example": "local_public", "type": "string" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "runtime": { "description": "The managed runtime used to execute the injected code.", "example": "nodejs-24", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]*\\-[0-9]*(\\.[0-9]*)?$", "type": "string" }, "scale_concurrency": { "default": 1, "description": "Number of parallel requests handled by a single instance, supported only by Node.js, default is `1`.", "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "scale_cpu_limit": { "description": "Optional amount of CPU set for the instance of the function.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": 1, "description": "Optional amount of time in seconds that delays the scale down behavior for a function.", "example": 300, "format": "int32", "maximum": 600, "minimum": 0, "type": "integer" }, "scale_max_execution_time": { "default": 60, "description": "Timeout in secs after which the function is terminated", "example": 60, "format": "int32", "maximum": 120, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "description": "Optional amount of memory set for the instance of the function.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "1G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" } }, "type": "object" }, "FunctionPrototype": { "description": "Request model for function create operations.", "example": { "code_reference": "data:text/plain;base64,", "name": "my-function", "runtime": "nodejs-24" }, "properties": { "code_binary": { "description": "Specifies whether the code is binary or not. Defaults to false when `code_reference` is set to a data URL.\nWhen `code_reference` is set to a code bundle URL, this field is always true.", "example": false, "type": "boolean" }, "code_main": { "default": "main", "description": "Specifies the name of the function that should be invoked.", "example": "main", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "code_reference": { "description": "Specifies either a reference to a code bundle or the source code itself.\nTo specify the source code, use the data URL scheme and include the source code as base64 encoded.\nThe data URL scheme is defined in [RFC 2397](https://tools.ietf.org/html/rfc2397).", "example": "data:text/plain;base64,", "maxLength": 1048576, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*", "type": "string" }, "code_secret": { "description": "The name of the secret that is used to access the specified `code_reference`.\nThe secret is used to authenticate with a non-public endpoint that is specified as`code_reference`.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "managed_domain_mappings": { "default": "local_public", "description": "Optional value controlling which of the system managed domain mappings will be setup for the function.\nValid values are 'local_public', 'local_private' and 'local'.\nVisibility can only be 'local_private' if the project supports function private visibility.", "enum": [ "local", "local_private", "local_public" ], "example": "local_public", "type": "string" }, "name": { "description": "The name of the function. Use a name that is unique within the project.", "example": "my-function", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "runtime": { "description": "The managed runtime used to execute the injected code.", "example": "nodejs-24", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]*\\-[0-9]*(\\.[0-9]*)?$", "type": "string" }, "scale_concurrency": { "default": 1, "description": "Number of parallel requests handled by a single instance, supported only by Node.js, default is `1`.", "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "scale_cpu_limit": { "default": "1", "description": "Optional amount of CPU set for the instance of the function.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_down_delay": { "default": 1, "description": "Optional amount of time in seconds that delays the scale down behavior for a function.", "example": 300, "format": "int32", "maximum": 600, "minimum": 0, "type": "integer" }, "scale_max_execution_time": { "default": 60, "description": "Timeout in secs after which the function is terminated", "example": 60, "format": "int32", "maximum": 120, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the function.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "1G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" } }, "required": [ "name", "runtime", "code_reference" ], "type": "object" }, "FunctionRuntime": { "description": "Response model for Function runtime objects.", "properties": { "default": { "description": "Whether the function runtime is the default for the code bundle family.", "example": true, "readOnly": true, "type": "boolean" }, "deprecated": { "description": "Whether the function runtime is deprecated.", "example": false, "readOnly": true, "type": "boolean" }, "family": { "description": "The code bundle family of the function runtime.", "example": "nodejs", "readOnly": true, "type": "string" }, "id": { "description": "The ID of the function runtime.", "example": "nodejs-24", "readOnly": true, "type": "string" }, "name": { "description": "The name of the function runtime.", "example": "Node.js 24", "readOnly": true, "type": "string" }, "optimized": { "description": "Whether the function runtime is optimized.", "example": true, "readOnly": true, "type": "boolean" } }, "required": [ "default", "deprecated", "family", "id", "name", "optimized" ], "type": "object" }, "FunctionRuntimeList": { "description": "Contains a list of Function runtimes.", "example": { "function_runtimes": [ { "default": true, "deprecated": false, "family": "nodejs", "id": "nodejs-22", "name": "Node.js 22", "optimized": true }, { "default": false, "deprecated": false, "family": "nodejs", "id": "nodejs-24", "name": "Node.js 24", "optimized": true }, { "default": true, "deprecated": false, "family": "python", "id": "python-3.13", "name": "Python 3.13", "optimized": true } ] }, "properties": { "function_runtimes": { "description": "List of all Function runtimes.", "items": { "$ref": "#/components/schemas/FunctionRuntime" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "required": [ "function_runtimes" ], "type": "object" }, "FunctionStatus": { "description": "The detailed status of the function.", "properties": { "reason": { "description": "Provides additional information about the status of the function.", "enum": [ "offline", "deploying_configuring_routes", "ready_update_in_progress", "deploying", "ready_last_update_failed", "ready", "unknown_reason", "no_code_bundle" ], "example": "offline", "readOnly": true, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "GPUPreference": { "example": { "allocation": "1", "family": "l40s" }, "properties": { "allocation": { "description": "The number of GPUs to be allocated per task instance.", "example": "1", "maxLength": 10, "minLength": 1, "pattern": "^.+$", "type": "string" }, "family": { "description": "The name of the GPU family.", "example": "l40s", "maxLength": 10, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "allocation", "family" ], "type": "object" }, "GPUPreferencePrototype": { "example": { "allocation": "1", "family": "l40s" }, "properties": { "allocation": { "description": "The number of GPUs to be allocated per task instance.", "example": "1", "maxLength": 10, "minLength": 1, "pattern": "^.+$", "type": "string" }, "family": { "description": "The name of the GPU family.", "example": "l40s", "maxLength": 10, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "allocation", "family" ], "type": "object" }, "GPUScale": { "description": "Optional information around allocation of GPUs to process tasks.", "example": { "preferences": [ { "allocation": "1", "family": "l40s" } ] }, "properties": { "preferences": { "description": "List of GPU preferences in descending order.", "items": { "$ref": "#/components/schemas/GPUPreference" }, "maxItems": 10, "minItems": 0, "type": "array" } }, "required": [ "preferences" ], "type": "object" }, "GPUScalePrototype": { "description": "Optional information around allocation of GPUs to process tasks.", "example": { "preferences": [ { "allocation": "1", "family": "l40s" } ] }, "properties": { "preferences": { "description": "List of GPU preferences in descending order.", "items": { "$ref": "#/components/schemas/GPUPreferencePrototype" }, "maxItems": 10, "minItems": 0, "type": "array" } }, "type": "object" }, "GenericSecretData": { "additionalProperties": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "description": "Data container that allows to specify config parameters and their values as a key-value map. Each key field must consist of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each value field can consists of any character and must not be exceed a max length of 1048576 characters.", "example": { "mykey": "my value" }, "type": "object" }, "HMACAuthSecretData": { "description": "Secret Data field used by HMAC secrets.", "example": { "access_key_id": "accessKeyId", "secret_access_key": "secretAccessKey" }, "properties": { "access_key_id": { "description": "HMAC access key id", "maxLength": 1048576, "minLength": 1, "pattern": ".*$", "type": "string" }, "secret_access_key": { "description": "HMAC secret access key", "maxLength": 1048576, "minLength": 1, "pattern": ".*$", "type": "string" } }, "required": [ "access_key_id", "secret_access_key" ], "type": "object" }, "IndexDetails": { "properties": { "finished_at": { "description": "The timestamp when the job run index finished processing.", "example": "2024-12-23T16:30:45Z", "readOnly": true, "type": "string" }, "last_failure_reason": { "description": "Reason why latest retry of the job run index failed. Possible values include but are not limited to `OOMKilled`, `ContainerExitedCode1` or `ExceededEphemeralStorage`.", "example": "OOMKilled", "readOnly": true, "type": "string" }, "retries": { "description": "Number of retries of this job run index.", "example": 3, "format": "int64", "maximum": 5, "minimum": 0, "readOnly": true, "type": "integer" }, "started_at": { "description": "The timestamp when the job run index started processing.", "example": "2024-12-23T16:20:30Z", "readOnly": true, "type": "string" }, "status": { "description": "Current status of the job run index.", "enum": [ "pending", "running", "succeeded", "failed", "unknown" ], "example": "running", "readOnly": true, "type": "string" } }, "required": [ "status" ], "type": "object" }, "IndicesTaskSource": { "description": "Input for tasks based on predetermined indices.", "example": { "indices": "0-99" }, "properties": { "indices": { "description": "Indice settings.", "example": "0-99", "maxLength": 128, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "indices" ], "type": "object" }, "IndicesTaskSourcePrototype": { "description": "Input for tasks based on predetermined indices.", "example": { "indices": "0-99" }, "properties": { "indices": { "description": "Indices settings.", "example": "0-99", "maxLength": 128, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "indices" ], "type": "object" }, "Job": { "description": "Job is the response model for job resources", "example": { "computed_env_variables": [], "created_at": "2022-11-15T21:40:40+01:00", "entity_tag": "2386231540", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job", "id": "7e49dd78-09d0-45c7-ad7e-cd968e0e7747", "image_reference": "icr.io/codeengine/helloworld", "name": "my-job", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_service_account": "default", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3 }, "properties": { "build": { "description": "Reference to a build that is associated with the job.", "example": "my-build", "readOnly": true, "type": "string" }, "build_run": { "description": "Reference to a build run that is associated with the job.", "example": "my-build-run", "readOnly": true, "type": "string" }, "computed_env_variables": { "description": "References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "entity_tag": { "description": "The version of the job instance, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "href": { "description": "When you provision a new job, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/jobs/my-job", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "image_reference": { "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too.\nThis property must not be set on a job run, which references a job template.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "name": { "description": "The name of the job.", "example": "my-job", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string", "x-terraform-force-new": true }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the job.", "enum": [ "job_v2" ], "readOnly": true, "type": "string" }, "run_arguments": { "description": "Set arguments for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "The user ID (UID) to run the job.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Set commands for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the job run.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_mode": { "default": "task", "description": "The mode for runs of the job. Valid values are `task` and `daemon`.\nIn `task` mode, the `max_execution_time` and `retry_limit` properties apply.\nIn `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.", "enum": [ "task", "daemon" ], "example": "task", "minLength": 0, "pattern": "^(task|daemon)$", "type": "string" }, "run_service_account": { "default": "default", "description": "The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`.\nThis property must not be set on a job run, which references a job template.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Optional mounts of config maps or secrets.", "items": { "$ref": "#/components/schemas/VolumeMount" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_array_spec": { "default": "0", "description": "Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27.\nEach instance gets its array index value from the environment variable JOB_INDEX.\nThe number of unique array indices that you specify with this parameter determines the number of job instances to run.", "example": "1-5,7-8,10", "maxLength": 253, "minLength": 1, "pattern": "^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$", "type": "string" }, "scale_cpu_limit": { "default": "1", "description": "Optional amount of CPU set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "Optional amount of ephemeral storage to set for the instance of the job.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_max_execution_time": { "default": 7200, "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", "example": 7200, "format": "int64", "maximum": 86400, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_retry_limit": { "default": 3, "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", "example": 3, "format": "int64", "maximum": 5, "minimum": 0, "type": "integer" } }, "required": [ "computed_env_variables", "created_at", "entity_tag", "href", "id", "image_reference", "project_id", "region", "name", "run_arguments", "run_commands", "run_env_variables", "run_mode", "run_service_account", "run_volume_mounts", "scale_array_spec", "scale_cpu_limit", "scale_ephemeral_storage_limit", "scale_memory_limit", "resource_type" ], "type": "object", "x-data-source-name": "code_engine_job", "x-data-source-operations": { "read": "get_job" }, "x-resource-name": "code_engine_job", "x-resource-operations": { "create": "create_job", "delete": "delete_job", "read": "get_job", "update": "update_job" } }, "JobList": { "description": "Contains a list of jobs and pagination information.", "example": { "jobs": [ { "computed_env_variables": [], "created_at": "2022-11-15T21:40:40+01:00", "entity_tag": "2386231540", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job", "id": "7e49dd78-09d0-45c7-ad7e-cd968e0e7747", "image_reference": "icr.io/codeengine/helloworld", "name": "my-job", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_service_account": "default", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3, "status": "ready" } ], "limit": 50 }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "jobs": { "description": "List of all jobs.", "items": { "$ref": "#/components/schemas/Job" }, "maxItems": 500, "minItems": 0, "type": "array" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "jobs", "limit" ], "type": "object" }, "JobPatch": { "description": "Request model for job update operations.", "example": { "image_reference": "icr.io/codeengine/hello", "run_env_variables": [ { "name": "MY_PROPERTY", "type": "literal", "value": "OTHER" } ] }, "properties": { "image_reference": { "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too.\nThis property must not be set on a job run, which references a job template.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "run_arguments": { "description": "Set arguments for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "The user ID (UID) to run the job.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Set commands for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_mode": { "description": "The mode for runs of the job. Valid values are `task` and `daemon`.\nIn `task` mode, the `max_execution_time` and `retry_limit` properties apply.\nIn `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.", "enum": [ "task", "daemon" ], "example": "task", "minLength": 0, "pattern": "^(task|daemon)$", "type": "string" }, "run_service_account": { "description": "The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`.\nThis property must not be set on a job run, which references a job template.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Optional mounts of config maps or a secrets. In case this is provided, existing `run_volume_mounts` will be overwritten.", "items": { "$ref": "#/components/schemas/VolumeMountPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_array_spec": { "description": "Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27.\nEach instance gets its array index value from the environment variable JOB_INDEX.\nThe number of unique array indices that you specify with this parameter determines the number of job instances to run.", "example": "1-5,7-8,10", "maxLength": 253, "minLength": 1, "pattern": "^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$", "type": "string" }, "scale_cpu_limit": { "description": "Optional amount of CPU set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_ephemeral_storage_limit": { "description": "Optional amount of ephemeral storage to set for the instance of the job.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_max_execution_time": { "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", "example": 7200, "format": "int64", "maximum": 86400, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "description": "Optional amount of memory set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_retry_limit": { "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", "example": 3, "format": "int64", "maximum": 5, "minimum": 0, "type": "integer" } }, "type": "object" }, "JobPrototype": { "description": "Request model for job create operations.", "example": { "image_reference": "icr.io/codeengine/helloworld", "name": "my-job", "run_env_variables": [ { "name": "MY_PROPERTY", "type": "literal", "value": "VALUE" } ] }, "properties": { "image_reference": { "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too.\nThis property must not be set on a job run, which references a job template.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "name": { "description": "The name of the job. Use a name that is unique within the project.", "example": "my-job", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "run_arguments": { "description": "Set arguments for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "The user ID (UID) to run the job.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Set commands for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_mode": { "default": "task", "description": "The mode for runs of the job. Valid values are `task` and `daemon`.\nIn `task` mode, the `max_execution_time` and `retry_limit` properties apply.\nIn `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.", "enum": [ "task", "daemon" ], "example": "task", "minLength": 0, "pattern": "^(task|daemon)$", "type": "string" }, "run_service_account": { "default": "default", "description": "The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`.\nThis property must not be set on a job run, which references a job template.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Optional mounts of config maps or a secrets.", "items": { "$ref": "#/components/schemas/VolumeMountPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_array_spec": { "default": "0", "description": "Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27.\nEach instance gets its array index value from the environment variable JOB_INDEX.\nThe number of unique array indices that you specify with this parameter determines the number of job instances to run.", "example": "1-5,7-8,10", "maxLength": 253, "minLength": 1, "pattern": "^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$", "type": "string" }, "scale_cpu_limit": { "default": "1", "description": "Optional amount of CPU set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "Optional amount of ephemeral storage to set for the instance of the job.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_max_execution_time": { "default": 7200, "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", "example": 7200, "format": "int64", "maximum": 86400, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_retry_limit": { "default": 3, "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", "example": 3, "format": "int64", "maximum": 5, "minimum": 0, "type": "integer" } }, "required": [ "image_reference", "name" ], "type": "object" }, "JobRun": { "description": "Response model for job run resources.", "example": { "computed_env_variables": [], "created_at": "2022-11-15T22:06:21+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job-run-1", "id": "ced5039e-b1d3-4c51-aa29-8dbde3531ace", "image_reference": "icr.io/codeengine/helloworld", "job_name": "my-job", "name": "my-job-run-1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_run_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_volume_mounts": [], "scale_array_spec": "0-1", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3, "status": "completed", "status_details": { "completion_time": "2024-10-31T13:17:18Z", "failed": 1, "failed_indices": "1", "indices_details": { "0": { "finished_at": "2024-10-31T12:13:15Z", "retries": 0, "started_at": "2024-10-31T12:12:05Z", "status": "succeeded" }, "1": { "finished_at": "2024-10-31T12:16:50Z", "last_failure_reason": "ExceededEphemeralStorage", "retries": 3, "started_at": "2024-10-31T12:12:05Z", "status": "failed" } }, "start_time": "2024-10-31T13:11:48Z", "succeedded": 1, "succeeded_indices": "0" } }, "properties": { "computed_env_variables": { "description": "References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "href": { "description": "When you provision a new job run, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/job_runs/my-job-run", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "image_reference": { "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too.\nThis property must not be set on a job run, which references a job template.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "job_name": { "description": "Optional name of the job reference of this job run.\nIf specified, the job run will inherit the configuration of the referenced job.", "example": "my-job", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "name": { "description": "The name of the job run.", "example": "my-job-run", "maxLength": 53, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the job run.", "enum": [ "job_run_v2" ], "readOnly": true, "type": "string" }, "run_arguments": { "description": "Set arguments for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "The user ID (UID) to run the job.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Set commands for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the job run.", "items": { "$ref": "#/components/schemas/EnvVar" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_mode": { "default": "task", "description": "The mode for runs of the job. Valid values are `task` and `daemon`.\nIn `task` mode, the `max_execution_time` and `retry_limit` properties apply.\nIn `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.", "enum": [ "task", "daemon" ], "example": "task", "minLength": 0, "pattern": "^(task|daemon)$", "type": "string" }, "run_service_account": { "default": "default", "description": "The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`.\nThis property must not be set on a job run, which references a job template.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Optional mounts of config maps or secrets.", "items": { "$ref": "#/components/schemas/VolumeMount" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_array_size_variable_override": { "description": "Optional value to override the JOB_ARRAY_SIZE environment variable for a job run.", "example": 2, "format": "int64", "maximum": 9999999, "minimum": 0, "type": "integer" }, "scale_array_spec": { "default": "0", "description": "Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27.\nEach instance gets its array index value from the environment variable JOB_INDEX.\nThe number of unique array indices that you specify with this parameter determines the number of job instances to run.", "example": "1-5,7-8,10", "maxLength": 253, "minLength": 1, "pattern": "^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$", "type": "string" }, "scale_cpu_limit": { "default": "1", "description": "Optional amount of CPU set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "Optional amount of ephemeral storage to set for the instance of the job.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_max_execution_time": { "default": 7200, "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", "example": 7200, "format": "int64", "maximum": 86400, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_retry_limit": { "default": 3, "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", "example": 3, "format": "int64", "maximum": 5, "minimum": 0, "type": "integer" }, "status": { "description": "The current status of the job run.", "enum": [ "failed", "completed", "running", "pending" ], "example": "failed", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/JobRunStatus" } }, "required": [ "computed_env_variables", "project_id", "run_arguments", "run_commands", "run_env_variables", "run_volume_mounts", "resource_type", "status" ], "type": "object" }, "JobRunList": { "description": "Contains a list of job runs and pagination information.", "example": { "job_runs": [ { "computed_env_variables": [], "created_at": "2022-11-15T22:06:21+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job-run-1", "id": "ced5039e-b1d3-4c51-aa29-8dbde3531ace", "image_reference": "icr.io/codeengine/helloworld", "job_name": "my-job", "name": "my-job-run-1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_run_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3, "status": "completed", "status_details": { "completion_time": "2024-10-31T13:17:18Z", "failed": 1, "failed_indices": "1", "indices_details": { "0": { "finished_at": "2024-10-31T12:13:15Z", "retries": 0, "started_at": "2024-10-31T12:12:05Z", "status": "succeeded" }, "1": { "finished_at": "2024-10-31T12:16:50Z", "last_failure_reason": "ExceededEphemeralStorage", "retries": 3, "started_at": "2024-10-31T12:12:05Z", "status": "failed" } }, "start_time": "2024-10-31T13:11:48Z", "succeedded": 1, "succeeded_indices": "0" } } ], "limit": 50 }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "job_runs": { "description": "List of all jobs.", "items": { "$ref": "#/components/schemas/JobRun" }, "maxItems": 500, "minItems": 0, "type": "array" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" } }, "required": [ "job_runs", "limit" ], "type": "object" }, "JobRunPrototype": { "description": "Request model for job run create operations.", "example": { "job_name": "my-job", "name": "my-job-run-1" }, "properties": { "image_reference": { "description": "The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional.\nIf `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`.\nIf the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.", "example": "icr.io/codeengine/helloworld", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][/])?[a-z0-9][a-z0-9\\-_./]+[a-z0-9](:[\\w][\\w.\\-]{0,127})?(@sha256:[a-fA-F0-9]{64})?$", "type": "string" }, "image_secret": { "description": "The name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image.\nIf the image reference points to a registry that requires authentication, the job / job runs will be created but submitted job runs will fail, until this property is provided, too.\nThis property must not be set on a job run, which references a job template.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "job_name": { "description": "Optional name of the job on which this job run is based on.\nIf specified, the job run will inherit the configuration of the referenced job.", "example": "my-job", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "name": { "description": "The name of the job. Use a name that is unique within the project.", "example": "my-job-run", "maxLength": 53, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" }, "run_arguments": { "description": "Set arguments for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_as_user": { "default": 0, "description": "The user ID (UID) to run the job.", "example": 1001, "format": "int64", "type": "integer" }, "run_commands": { "description": "Set commands for the job that are passed to start job run containers.\nIf not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.", "items": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_compute_resource_token_enabled": { "default": false, "description": "Optional flag to enable the use of a compute resource token mounted to the container file system.", "example": true, "type": "boolean" }, "run_env_variables": { "description": "Optional references to config maps, secrets or literal values.", "items": { "$ref": "#/components/schemas/EnvVarPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "run_mode": { "default": "task", "description": "The mode for runs of the job. Valid values are `task` and `daemon`.\nIn `task` mode, the `max_execution_time` and `retry_limit` properties apply.\nIn `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.", "enum": [ "task", "daemon" ], "example": "task", "minLength": 0, "pattern": "^(task|daemon)$", "type": "string" }, "run_service_account": { "default": "default", "description": "The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`.\nThis property must not be set on a job run, which references a job template.", "enum": [ "default", "manager", "reader", "writer", "none" ], "example": "default", "minLength": 0, "pattern": "^(manager|reader|writer|none|default)$", "type": "string" }, "run_volume_mounts": { "description": "Optional mounts of config maps or a secrets.", "items": { "$ref": "#/components/schemas/VolumeMountPrototype" }, "maxItems": 100, "minItems": 0, "type": "array" }, "scale_array_size_variable_override": { "description": "Optional value to override the JOB_ARRAY_SIZE environment variable for a job run.", "example": 2, "format": "int64", "type": "integer" }, "scale_array_spec": { "default": "0", "description": "Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27.\nEach instance gets its array index value from the environment variable JOB_INDEX.\nThe number of unique array indices that you specify with this parameter determines the number of job instances to run.", "example": "1-5,7-8,10", "maxLength": 253, "minLength": 1, "pattern": "^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$", "type": "string" }, "scale_cpu_limit": { "default": "1", "description": "Optional amount of CPU set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).", "example": "1", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_ephemeral_storage_limit": { "default": "400M", "description": "Optional amount of ephemeral storage to set for the instance of the job.\nThe amount specified as ephemeral storage, must not exceed the amount of `scale_memory_limit`.\nThe units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_max_execution_time": { "default": 7200, "description": "The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is `task`.", "example": 7200, "format": "int64", "maximum": 86400, "minimum": 1, "type": "integer" }, "scale_memory_limit": { "default": "4G", "description": "Optional amount of memory set for the instance of the job.\nFor valid values see [Supported memory and CPU combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).\nThe units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).", "example": "4G", "maxLength": 10, "minLength": 0, "pattern": "^([0-9.]+)([eEinumkKMGTPB]*)$", "type": "string" }, "scale_retry_limit": { "default": 3, "description": "The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if `run_mode` is `task`.", "example": 3, "format": "int64", "maximum": 5, "minimum": 0, "type": "integer" } }, "type": "object" }, "JobRunStatus": { "description": "The detailed status of the job run.", "example": { "completion_time": "2022-09-22T17:40:00Z", "failed": 0, "pending": 0, "requested": 0, "running": 0, "start_time": "2022-09-22T17:34:00Z", "succeeded": 1, "unknown": 0 }, "properties": { "completion_time": { "description": "Time the job run completed.", "example": "2022-09-22T17:40:00Z", "readOnly": true, "type": "string" }, "failed": { "description": "Number of failed job run instances.", "example": 0, "format": "int32", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "failed_indices": { "description": "List of job run indices that failed.", "example": "1,5", "readOnly": true, "type": "string" }, "indices_details": { "additionalProperties": { "$ref": "#/components/schemas/IndexDetails" }, "description": "Detailed process information per index.", "type": "object" }, "pending": { "description": "Number of pending job run instances.", "example": 0, "format": "int32", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "pending_indices": { "description": "List of job run indices that are pending.", "example": "9,12-15", "readOnly": true, "type": "string" }, "requested": { "description": "Number of requested job run instances.", "example": 0, "format": "int32", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "running": { "description": "Number of running job run instances.", "example": 0, "format": "int32", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "running_indices": { "description": "List of job run indices that are running.", "example": "10-11", "readOnly": true, "type": "string" }, "start_time": { "description": "Time the job run started.", "example": "2022-09-22T17:34:00Z", "readOnly": true, "type": "string" }, "succeeded": { "description": "Number of succeeded job run instances.", "example": 1, "format": "int32", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "succeeded_indices": { "description": "List of job run indices that succeeded.", "example": "2-4,6-8", "readOnly": true, "type": "string" }, "unknown": { "description": "Number of job run instances with unknown state.", "example": 0, "format": "int32", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" } }, "type": "object" }, "JsonReference": { "description": "Defintion of a file-based task source.", "example": { "json_reference": { "object_path": "/my/bucket/data/object.json", "persistent_data_store": "my-persistent-data-store" } }, "properties": { "json_reference": { "$ref": "#/components/schemas/JsonReferenceData" } }, "required": [ "json_reference" ], "type": "object" }, "JsonReferenceData": { "description": "Defintion of a file-based task source.", "properties": { "object_path": { "description": "Prefix determining the location of the references JSON file.", "example": "/my/bucket/data/object.jsonl", "maxLength": 1000, "minLength": 1, "pattern": "^.+$", "type": "string" }, "persistent_data_store": { "description": "Name of referenced persistent data store resource.", "example": "my-fleet-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "persistent_data_store", "object_path" ], "type": "object" }, "JsonReferencePrototype": { "description": "Defintion of a file-based task source.", "example": { "json_reference": { "object_path": "/my/bucket/data/object.json", "persistent_data_store": "my-persistent-data-store" } }, "properties": { "json_reference": { "$ref": "#/components/schemas/JsonReferenceData" } }, "required": [ "json_reference" ], "type": "object" }, "JsonTaskData": { "description": "Data values for inline tasks.", "properties": { "args": { "description": "List of arguments that are passed to the task container.", "items": { "example": "arg1", "maxLength": 1023, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" }, "cmds": { "description": "List of commands that are run as part of the task container.", "items": { "example": "cmd", "maxLength": 1023, "minLength": 1, "pattern": "^.+$", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "type": "object" }, "JsonTaskPrototype": { "description": "Input for tasks based on a list of inline specifications.", "example": { "json": [ { "args": [ "arg1" ], "cmds": [ "cmd1", "cmd2" ] } ] }, "properties": { "json": { "description": "List of provided task for processing", "items": { "$ref": "#/components/schemas/JsonTaskData" }, "maxItems": 10000, "minItems": 1, "type": "array" } }, "required": [ "json" ], "type": "object" }, "ListFirstMetadata": { "description": "Describes properties needed to retrieve the first page of a result list.", "example": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets?limit=50" }, "properties": { "href": { "description": "Href that points to the first page.", "type": "string" } }, "type": "object" }, "ListNextMetadata": { "description": "Describes properties needed to retrieve the next page of a result list.", "example": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets?limit=50&start=eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6NDA5MzY4OTcxMSwic3RhcnQiOiJjZS1zZXJ2aWNlc1x1MDAwMCJ9", "start": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6NDA5MzY4OTcxMSwic3RhcnQiOiJjZS1zZXJ2aWNlc1x1MDAwMCJ9" }, "properties": { "href": { "description": "Href that points to the next page.", "type": "string" }, "start": { "description": "Token.", "type": "string" } }, "type": "object" }, "LoggingFleetSettings": { "description": "LoggingFleetSettings identifies the IBM Cloud Log Analysis instance for fleet-level log forwarding.", "example": { "ingestion_secret": "my-log-secret", "instance_crn": "crn:v1:bluemix:public:logs:us-east:a/4329073d16d2f3663f74bfa955259139:a1b2c3d4-e5f6-7890-abcd-ef1234567890::", "level_agent": "info", "level_worker": "info" }, "properties": { "ingestion_secret": { "description": "IngestionSecret is the name of the secret containing the ingestion key.", "example": "my-log-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "instance_crn": { "description": "InstanceCrn is the IBM Cloud Log Analysis instance CRN.", "example": "crn:v1:bluemix:public:logs:us-east:a/4329073d16d2f3663f74bfa955259139:a1b2c3d4-e5f6-7890-abcd-ef1234567890::", "maxLength": 512, "minLength": 9, "pattern": "^crn\\:v1\\:[a-zA-Z0-9]*\\:(public|dedicated|local)\\:[\\-a-z0-9]*\\:([a-z][\\-a-z0-9_]*[a-z0-9])?\\:((a|o|s)/[\\-a-z0-9]+)?\\:[\\-a-z0-9/]*\\:[\\-a-zA-Z0-9]*(\\:[\\-a-zA-Z0-9/.]*)?$", "type": "string" }, "level_agent": { "description": "LevelAgent is the log level for the fleet agent.", "enum": [ "debug", "info", "warn", "error" ], "example": "info", "pattern": "^(debug|info|warn|error)$", "type": "string" }, "level_worker": { "description": "LevelWorker is the log level for fleet worker processes.", "enum": [ "debug", "info", "warn", "error" ], "example": "info", "pattern": "^(debug|info|warn|error)$", "type": "string" } }, "required": [ "level_agent", "level_worker" ], "type": "object" }, "MonitoringFleetSettings": { "description": "MonitoringFleetSettings identifies the IBM Cloud Monitoring instance for fleet-level forwarding.", "example": { "ingestion_secret": "my-mon-secret", "region": "us-east" }, "properties": { "ingestion_secret": { "description": "IngestionSecret is the name of the secret containing the ingestion key.", "example": "my-mon-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "region": { "description": "Region is the IBM Cloud Monitoring region (e.g. \"us-east\").", "example": "us-east", "maxLength": 63, "minLength": 5, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", "type": "string" } }, "type": "object" }, "NetworkPlacement": { "example": { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" }, "properties": { "reference": { "description": "Name of the referenced location.", "example": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "type": { "description": "Determines the type of the referenced location.", "enum": [ "subnet_pool" ], "example": "subnet_pool", "maxLength": 32, "minLength": 1, "pattern": "^(subnet_pool)$", "readOnly": true, "type": "string" } }, "required": [ "reference", "type" ], "type": "object" }, "NetworkPlacementPrototype": { "example": { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" }, "properties": { "reference": { "description": "ID of the referenced location.", "example": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" }, "type": { "description": "Determines the type of the referenced location.", "enum": [ "subnet_pool" ], "example": "subnet_pool", "maxLength": 32, "minLength": 1, "pattern": "^(subnet_pool)$", "type": "string" } }, "required": [ "reference", "type" ], "type": "object" }, "NetworkPlacementSettings": { "description": "NetworkPlacementSettings identifies a subnet pool used for fleet worker network placement.", "example": { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" }, "properties": { "reference": { "description": "Reference is the name or ID of the network resource.", "example": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" }, "type": { "description": "Type is the kind of network resource (currently always \"subnet_pool\").", "enum": [ "subnet_pool" ], "example": "subnet_pool", "maxLength": 32, "minLength": 1, "pattern": "^(subnet_pool)$", "type": "string" } }, "required": [ "type", "reference" ], "type": "object" }, "ObjectStorageData": { "description": "Data container that allows to specify config parameters and their values as a key-value map. Each key field must consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value field can consists of any character and must not exceed a max length of 1048576 characters.", "example": { "bucket_location": "us-south", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "properties": { "bucket_location": { "description": "Specify the location of the bucket.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z0-9-]+$", "type": "string", "x-terraform-force-new": true }, "bucket_name": { "description": "Specify the name of the bucket", "maxLength": 63, "minLength": 3, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": "string", "x-terraform-force-new": true }, "secret_name": { "description": "Specify the name of the HMAC secret.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string", "x-terraform-force-new": true } }, "required": [ "bucket_location", "bucket_name", "secret_name" ], "type": "object" }, "OperatorSecretProps": { "description": "Properties for the IBM Cloud Operator Secret", "properties": { "apikey_id": { "description": "The ID of the apikey associated with the operator secret", "example": "ApiKey-17041d26-55e4-40a8-8ab5-5a69b68e204b", "maxLength": 43, "minLength": 43, "pattern": "^ApiKey-[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" }, "resource_group_ids": { "description": "The list of resource groups (by ID) that the operator secret can bind services in", "items": { "maxLength": 32, "minLength": 32, "pattern": "^[a-z0-9]*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "serviceid": { "$ref": "#/components/schemas/ServiceIDRef" }, "user_managed": { "description": "Specifies whether the operator secret is user managed", "type": "boolean" } }, "required": [ "apikey_id", "resource_group_ids", "serviceid", "user_managed" ], "type": "object" }, "OperatorSecretPrototypeProps": { "description": "Properties for the IBM Cloud Operator Secrets", "properties": { "resource_group_ids": { "description": "The list of resource groups (by ID) that the operator secret can bind services in", "items": { "maxLength": 32, "minLength": 32, "pattern": "^[a-z0-9]*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "serviceid": { "$ref": "#/components/schemas/ServiceIDRefPrototype" } }, "type": "object" }, "PersistentDataStore": { "description": "Describes the model of a persistent data store.", "example": { "created_at": "2025-05-15T22:07:55+01:00", "data": { "bucket_location": "us-east", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "entity_tag": "2385407409", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "name": "my-persistent-data-store", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "persistent_data_store_v2", "storage_type": "object_storage" }, "properties": { "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "data": { "$ref": "#/components/schemas/StorageData" }, "entity_tag": { "description": "The version of the persistent data store, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "href": { "description": "When you provision a new persistent data store, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/persistent_data_stores/my-persistent-data-store", "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "readOnly": true, "type": "string" }, "name": { "description": "The name of the persistent data store.", "example": "my-persistent-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the persistent data store.", "enum": [ "persistent_data_store_v2" ], "readOnly": true, "type": "string" }, "storage_type": { "description": "Specify the storage type of the persistent data store.", "enum": [ "object_storage" ], "example": "object_storage", "pattern": "^(object_storage)$", "type": "string", "x-terraform-force-new": true } }, "required": [ "name", "storage_type", "entity_tag", "created_at", "id", "project_id", "region", "data", "resource_type" ], "type": "object", "x-data-source-name": "code_engine_persistent_data_store", "x-data-source-operations": { "read": "get_persistent_data_store" }, "x-resource-name": "code_engine_persistent_data_store", "x-resource-operations": { "create": "create_persistent_data_store", "delete": "delete_persistent_data_store", "read": "get_persistent_data_store" } }, "PersistentDataStoreList": { "description": "List of all persistent data stores.", "example": { "limit": 50, "persistent_data_stores": [ { "created_at": "2025-05-15T22:07:55+01:00", "data": { "bucket_location": "us-east", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "entity_tag": "2385407409", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "name": "my-persistent-data-store", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "persistent_data_store_v2", "storage_type": "object_storage" } ] }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" }, "persistent_data_stores": { "description": "List of persistent data stores.", "items": { "$ref": "#/components/schemas/PersistentDataStore" }, "maxItems": 500, "minItems": 0, "type": "array" } }, "required": [ "persistent_data_stores", "limit" ], "type": "object" }, "PersistentDataStorePrototype": { "description": "PersistentDataStorePrototype is the request model for persistent data store.", "example": { "data": { "bucket_location": "us-east", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "name": "my-persistent-data-store", "storage_type": "object_storage" }, "properties": { "data": { "$ref": "#/components/schemas/StorageData" }, "name": { "description": "The name of the persistent data store.", "example": "my-persistent-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "storage_type": { "description": "Specify the storage type of the persistent data store.", "enum": [ "object_storage" ], "example": "object_storage", "pattern": "^(object_storage)$", "type": "string" } }, "required": [ "name", "storage_type" ], "type": "object" }, "PrivatePathServiceGatewayData": { "description": "Allowed outbound destination of type VPC Private Path service.", "example": { "isolation_policy": "shared", "private_path_service_gateway_crn": "crn:v1:bluemix:public:is:eu-de:a/7658687ea07db8396963ebe2b8e1897d::private-path-service-gateway:r010-5c225308-b699-43c7-a208-aae9aac7326a" }, "properties": { "isolation_policy": { "default": "shared", "description": "Optional property to specify the isolation policy of the private path service gateway. If set to `shared`, other projects within the same account or enterprise account family can connect to Private Path service, too. If set to `dedicated` the gateway can only be used by a single Code Engine project. If not specified the isolation policy will be set to `shared`.", "enum": [ "shared", "dedicated" ], "example": "shared", "type": "string" }, "private_path_service_gateway_crn": { "description": "The CRN of the Private Path service.", "maxLength": 253, "minLength": 20, "pattern": "^crn\\:v1\\:[a-zA-Z0-9]*\\:(public|dedicated|local)\\:is\\:([a-z][\\-a-z0-9_]*[a-z0-9])?\\:((a|o|s)/[\\-a-z0-9]+)?\\:\\:private-path-service-gateway\\:[\\-a-zA-Z0-9/.]*$", "type": "string", "x-terraform-force-new": true } }, "required": [ "private_path_service_gateway_crn", "isolation_policy" ], "type": "object" }, "PrivatePathServiceGatewayDataPatch": { "description": "Updating properties of an allowed outbound destination of type VPC Private Path service.", "example": { "isolation_policy": "shared" }, "properties": { "isolation_policy": { "description": "Optional property to specify the isolation policy of the private path service gateway. If set to `shared`, other projects within the same account or enterprise account family can connect to Private Path service, too. If set to `dedicated` the gateway can only be used by a single Code Engine project. If not specified the isolation policy will be set to `shared`.", "enum": [ "shared", "dedicated" ], "example": "shared", "type": "string" } }, "type": "object" }, "PrivatePathServiceGatewayDataPrototype": { "description": "Create an allowed outbound destination by connecting to a VPC Private Path service.", "example": { "isolation_policy": "shared", "private_path_service_gateway_crn": "crn:v1:bluemix:public:is:eu-de:a/7658687ea07db8396963ebe2b8e1897d::private-path-service-gateway:r010-5c225308-b699-43c7-a208-aae9aac7326a" }, "properties": { "isolation_policy": { "default": "shared", "description": "Optional property to specify the isolation policy of the private path service gateway. If set to `shared`, other projects within the same account or enterprise account family can connect to Private Path service, too. If set to `dedicated` the gateway can only be used by a single Code Engine project. If not specified the isolation policy will be set to `shared`.", "enum": [ "shared", "dedicated" ], "example": "shared", "type": "string" }, "private_path_service_gateway_crn": { "description": "The CRN of the Private Path service. The CRN can be obtained in the resource details of the target Private Path service. [Learn more](https://cloud.ibm.com/docs/vpc?topic=vpc-pps-ui-communicate)", "maxLength": 253, "minLength": 20, "pattern": "^crn\\:v1\\:[a-zA-Z0-9]*\\:(public|dedicated|local)\\:is\\:([a-z][\\-a-z0-9_]*[a-z0-9])?\\:((a|o|s)/[\\-a-z0-9]+)?\\:\\:private-path-service-gateway\\:[\\-a-zA-Z0-9/.]*$", "type": "string" } }, "required": [ "private_path_service_gateway_crn" ], "type": "object" }, "PrivatePathServiceGatewayDetails": { "description": "Optional information about the private path service gateway that this allowed outbound destination points to.", "properties": { "id": { "description": "The private path service gateway identifier", "example": "r006-7268d425-59b7-48fd-9735-81a7271657d5", "readOnly": true, "type": "string" }, "name": { "description": "The name of private path service gateway.", "example": "my-private-path-service-gateway", "readOnly": true, "type": "string" }, "service_endpoints": { "description": "The fully qualified domain names for this private path service gateway. The domains are used for endpoint gateways to connect to the service and are configured in the VPC for each endpoint gateway.", "example": [ "my-private-path-service-gateway" ], "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "id", "name", "service_endpoints" ], "type": "object" }, "PrivatePathServiceGatewayStatusDetails": { "description": "Detailed status information related to the corresponding VPC Private Path service.", "example": { "endpoint_gateway": { "account_id": "175b993c36534af6be7a6499ce289d90", "created_at": "2026-01-20T14:38:56+01:00", "ips": [ "192.168.160.25", "192.168.64.25", "192.168.96.26" ], "name": "code-engine-test-fecb72" }, "private_path_service_gateway": { "id": "r010-5c225308-b699-43c7-a208-aae9aac7326a", "name": "private-path-demo--is-vpc-pps", "service_endpoints": [ "api.ce-3a7ec0849d8c.intra" ] }, "reason": "ready" }, "properties": { "endpoint_gateway": { "$ref": "#/components/schemas/EndpointGatewayDetails" }, "private_path_service_gateway": { "$ref": "#/components/schemas/PrivatePathServiceGatewayDetails" }, "reason": { "description": "Optional information to provide more context in case of a 'failed' or 'deploying' status.", "enum": [ "ready", "private_path_crn_invalid", "private_path_not_in_same_region", "private_path_not_in_same_account_family", "private_path_not_found", "private_path_not_published", "private_path_connection_already_exists", "private_path_connection_approval_denied", "private_path_connection_approval_pending", "deploying", "failed" ], "example": "ready", "readOnly": true, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "Probe": { "description": "Response model for probes", "properties": { "failure_threshold": { "default": 1, "description": "The number of consecutive, unsuccessful checks for the probe to be considered failed.", "example": 5, "format": "int32", "maximum": 10, "minimum": 1, "type": "integer" }, "initial_delay": { "description": "The amount of time in seconds to wait before the first probe check is performed.", "example": 5, "format": "int32", "maximum": 10, "minimum": 1, "type": "integer" }, "interval": { "default": 10, "description": "The amount of time in seconds between probe checks.", "example": 5, "format": "int32", "maximum": 60, "minimum": 1, "type": "integer" }, "path": { "description": "The path of the HTTP request to the resource. A path is only supported for a probe with a `type` of `http`.", "maxLength": 2048, "minLength": 0, "pattern": "^\\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\\/?]|%[a-fA-F0-9]{2})*)?$", "type": "string" }, "port": { "description": "The port on which to probe the resource, or 0 to probe the default app port 8080.", "example": 8080, "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "timeout": { "default": 1, "description": "The amount of time in seconds that the probe waits for a response from the application before it times out and fails.", "example": 300, "format": "int32", "maximum": 3600, "minimum": 1, "type": "integer" }, "type": { "description": "Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.", "enum": [ "tcp", "http" ], "example": "tcp", "type": "string" } }, "required": [ "type" ], "type": "object" }, "ProbePrototype": { "description": "Request model for probes", "properties": { "failure_threshold": { "default": 1, "description": "The number of consecutive, unsuccessful checks for the probe to be considered failed.", "example": 5, "format": "int32", "maximum": 10, "minimum": 1, "type": "integer" }, "initial_delay": { "description": "The amount of time in seconds to wait before the first probe check is performed.", "example": 5, "format": "int32", "maximum": 10, "minimum": 1, "type": "integer" }, "interval": { "default": 10, "description": "The amount of time in seconds between probe checks.", "example": 5, "format": "int32", "maximum": 60, "minimum": 1, "type": "integer" }, "path": { "description": "The path of the HTTP request to the resource. A path is only supported for a probe with a `type` of `http`.", "maxLength": 2048, "minLength": 0, "pattern": "^\\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\\/?]|%[a-fA-F0-9]{2})*)?$", "type": "string" }, "port": { "description": "The port on which to probe the resource.", "example": 8080, "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "timeout": { "default": 1, "description": "The amount of time in seconds that the probe waits for a response from the application before it times out and fails.", "example": 300, "format": "int32", "maximum": 3600, "minimum": 1, "type": "integer" }, "type": { "description": "Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.", "enum": [ "tcp", "http" ], "example": "tcp", "type": "string" } }, "type": "object" }, "Project": { "description": "Describes the model of a project.", "example": { "account_id": "f9f1030ebf674eda8d57bdbc2b9e536a", "created_at": "2021-03-29T12:18:13.992359829Z", "crn": "crn:v1:bluemix:public:codeengine:us-east:a/4329073d16d2f3663f74bfa955259139:15314cc3-85b4-4338-903f-c28cdee6d005::", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005", "id": "15314cc3-85b4-4338-903f-c28cdee6d005", "name": "test_project", "region": "us-east", "resource_group_id": "b91e849cedb04e7e92bd68c040c672dc", "resource_type": "project_v2", "status": "active" }, "properties": { "account_id": { "description": "The ID of the account of the project, e.g. 4329073d16d2f3663f74bfa955259139.", "example": "4329073d16d2f3663f74bfa955259139", "readOnly": true, "type": "string", "x-terraform-user-account": true }, "created_at": { "description": "The timestamp when the project was created.", "example": "2021-03-29T12:18:13.992359829Z", "readOnly": true, "type": "string" }, "crn": { "description": "The CRN of the project.", "example": "crn:v1:bluemix:public:codeengine:eu-de:a/4329073d16d2f3663f74bfa955259139:4e49b3e0-27a8-48d2-a784-c7ee48bb863b::", "readOnly": true, "type": "string" }, "href": { "description": "When you provision a new resource, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The ID of the project.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "name": { "description": "The name of the project.", "example": "project-name", "maxLength": 128, "minLength": 1, "pattern": "^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$", "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region for your project deployment. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_group_id": { "description": "The ID of the resource group.", "example": "5c49eabcf5e85881a37e2d100a33b3df", "maxLength": 32, "minLength": 32, "pattern": "^[a-z0-9]*$", "type": "string" }, "resource_type": { "description": "The type of the project.", "enum": [ "project_v2" ], "readOnly": true, "type": "string" }, "status": { "description": "The current state of the project. For example, when the project is created and is ready for use, the status of the project is active.", "enum": [ "active", "inactive", "pending_removal", "hard_deleting", "hard_deletion_failed", "hard_deleted", "deleting", "deletion_failed", "soft_deleted", "preparing", "creating", "creation_failed" ], "example": "active", "readOnly": true, "type": "string" } }, "required": [ "account_id", "crn", "created_at", "id", "name", "region", "resource_group_id", "status", "resource_type", "href" ], "type": "object", "x-data-source-name": "code_engine_project", "x-data-source-operations": { "read": "get_project" }, "x-resource-name": "code_engine_project", "x-resource-operations": { "create": "create_project", "delete": "delete_project", "read": "get_project" }, "x-terraform-timeouts": { "create": 10 } }, "ProjectConnectivitySettings": { "description": "ProjectConnectivitySettings holds project-wide inbound connectivity settings.", "example": { "inbound_private_dns": "ibm_cloud_classic_network" }, "properties": { "inbound_private_dns": { "description": "InboundPrivateDns configures the private DNS inbound mode.", "enum": [ "ibm_cloud_classic_network", "ibm_bluezone_network", "none", "custom_network" ], "example": "ibm_cloud_classic_network", "pattern": "^(ibm_cloud_classic_network|ibm_bluezone_network|none|custom_network)$", "type": "string" } }, "required": [ "inbound_private_dns" ], "type": "object" }, "ProjectConnectivitySettingsPatch": { "description": "ProjectConnectivitySettingsPatch updates project-wide inbound connectivity settings.", "example": { "inbound_private_dns": "ibm_cloud_classic_network" }, "properties": { "inbound_private_dns": { "description": "InboundPrivateDns sets the private DNS inbound mode.\nPermitted values: ibm_cloud_classic_network only (operator values are rejected with 400).", "enum": [ "ibm_cloud_classic_network", "ibm_bluezone_network", "none", "custom_network" ], "pattern": "^(ibm_cloud_classic_network|ibm_bluezone_network|none|custom_network)$", "type": "string" } }, "type": "object" }, "ProjectEgressIPAddresses": { "description": "Describes the model of egress IP addresses.", "example": { "private": [ "10.223.236.11", "10.223.242.142", "10.12.3.244" ], "public": [ "159.23.99.151", "130.198.13.241", "135.90.137.31" ] }, "properties": { "private": { "description": "List of IBM private network IP addresses", "items": { "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "public": { "description": "List of public IP addresses", "items": { "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "type": "object" }, "ProjectFleetSettings": { "description": "ProjectFleetSettings holds project-wide default values for fleet resources.", "example": { "default_network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "default_tasks_state_store": { "persistent_data_store": "my-pds", "sub_path": "my/bucket/data" } }, "properties": { "default_network_placements": { "description": "DefaultNetworkPlacements is the list of default network placements for fleet workers.\nNull means the field is not set.", "items": { "$ref": "#/components/schemas/NetworkPlacementSettings" }, "maxItems": 100, "minItems": 0, "type": "array" }, "default_tasks_state_store": { "$ref": "#/components/schemas/TasksStateStoreSettings" } }, "required": [ "default_network_placements" ], "type": "object" }, "ProjectFleetSettingsPatch": { "description": "ProjectFleetSettingsPatch updates project-wide fleet defaults. Only non-absent fields are applied.", "example": { "default_network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "default_tasks_state_store": { "persistent_data_store": "my-pds", "sub_path": "my/bucket/data" } }, "properties": { "default_network_placements": { "description": "DefaultNetworkPlacements sets or clears the default network placements.\nSet to null to reset. Each call replaces the entire array.", "items": { "$ref": "#/components/schemas/NetworkPlacementSettings" }, "maxItems": 100, "minItems": 0, "type": "array" }, "default_tasks_state_store": { "$ref": "#/components/schemas/TasksStateStoreSettings" } }, "type": "object" }, "ProjectList": { "description": "Contains a list of projects and pagination information.", "example": { "limit": 50, "projects": [ { "account_id": "f9f1030ebf674eda8d57bdbc2b9e536a", "created_at": "2021-03-29T12:18:13.992359829Z", "crn": "crn:v1:bluemix:public:codeengine:us-east:a/4329073d16d2f3663f74bfa955259139:15314cc3-85b4-4338-903f-c28cdee6d005::", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005", "id": "15314cc3-85b4-4338-903f-c28cdee6d005", "name": "test_project", "region": "us-east", "resource_group_id": "b91e849cedb04e7e92bd68c040c672dc", "resource_type": "project_v2", "status": "active" } ] }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" }, "projects": { "description": "List of projects.", "items": { "$ref": "#/components/schemas/Project" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "required": [ "projects", "limit" ], "type": "object" }, "ProjectLoggingSettings": { "description": "ProjectLoggingSettings holds project-wide logging configuration.", "example": { "fleet": { "ingestion_secret": "my-log-secret", "instance_crn": "crn:v1:bluemix:public:logs:us-east:a/4329073d16d2f3663f74bfa955259139:a1b2c3d4-e5f6-7890-abcd-ef1234567890::", "level_agent": "info", "level_worker": "info" } }, "properties": { "fleet": { "$ref": "#/components/schemas/LoggingFleetSettings" } }, "type": "object" }, "ProjectLoggingSettingsPatch": { "description": "ProjectLoggingSettingsPatch updates project-wide logging settings. Set Fleet to null to clear the fleet logging block.", "example": { "fleet": { "ingestion_secret": "my-log-secret", "instance_crn": "crn:v1:bluemix:public:logs:us-east:a/4329073d16d2f3663f74bfa955259139:a1b2c3d4-e5f6-7890-abcd-ef1234567890::", "level_agent": "info", "level_worker": "info" } }, "properties": { "fleet": { "$ref": "#/components/schemas/LoggingFleetSettings" } }, "type": "object" }, "ProjectMonitoringSettings": { "description": "ProjectMonitoringSettings holds project-wide monitoring configuration.", "example": { "fleet": { "ingestion_secret": "my-mon-secret", "region": "us-east" }, "standard_metrics": { "app_metrics": "on", "compute_metrics": "off", "enable": "custom", "fleet_metrics": "on", "function_metrics": "on", "gpu_metrics": "on", "job_metrics": "on" } }, "properties": { "fleet": { "$ref": "#/components/schemas/MonitoringFleetSettings" }, "standard_metrics": { "$ref": "#/components/schemas/StandardMetricsSettings" } }, "type": "object" }, "ProjectMonitoringSettingsPatch": { "description": "ProjectMonitoringSettingsPatch updates project-wide monitoring settings. Only non-absent fields are applied.", "example": { "fleet": { "ingestion_secret": "my-mon-secret", "region": "us-east" }, "standard_metrics": { "app_metrics": "on", "compute_metrics": "off", "enable": "custom", "fleet_metrics": "on", "function_metrics": "on", "gpu_metrics": "on", "job_metrics": "on" } }, "properties": { "fleet": { "$ref": "#/components/schemas/MonitoringFleetSettings" }, "standard_metrics": { "$ref": "#/components/schemas/StandardMetricsSettings" } }, "type": "object" }, "ProjectPrototype": { "description": "Model to create a project instance.", "example": { "name": "test_project", "resource_group_id": "b91e849cedb04e7e92bd68c040c672dc", "tags": [ "code-engine", "my-tag" ] }, "properties": { "name": { "description": "The name of the project.", "example": "my-project", "maxLength": 128, "minLength": 1, "pattern": "^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$", "type": "string" }, "resource_group_id": { "description": "Optional ID of the resource group for your project deployment.\nIf this field is not defined, the default resource group of the account will be used.", "example": "b91e849cedb04e7e92bd68c040c672dc", "maxLength": 32, "minLength": 32, "pattern": "^[a-z0-9]*$", "type": "string" }, "tags": { "description": "Optional list of labels to assign to your project. Tags are not part of the project resource that is returned by the server, but can be obtained and managed through the Global Tagging API in IBM Cloud. Find more information on [Global Tagging API docs](https://cloud.ibm.com/apidocs/tagging).", "items": { "maxLength": 128, "minLength": 1, "pattern": "^([ ]*[A-Za-z0-9:_.\\-]+[ ]*)+$", "type": "string" }, "maxItems": 10, "minItems": 0, "type": "array" } }, "required": [ "name" ], "type": "object" }, "ProjectRegistrySettings": { "description": "ProjectRegistrySettings holds per-region IBM Container Registry enablement settings.", "example": { "regions": { "us_east": { "enablement_status": "enabled", "secret": "ce-auto-icr-private-us-east" }, "us_south": { "enablement_status": "disabled" } } }, "properties": { "regions": { "additionalProperties": { "$ref": "#/components/schemas/RegistryRegionSettings" }, "description": "Regions is a map of region name (underscore form, e.g. \"eu_de\") to its registry settings.", "type": "object" } }, "type": "object" }, "ProjectRegistrySettingsPatch": { "description": "ProjectRegistrySettingsPatch updates per-region ICR enablement.", "example": { "regions": { "us_east": { "enablement_status": "enabled" }, "us_south": { "enablement_status": "disabled" } } }, "properties": { "regions": { "additionalProperties": { "$ref": "#/components/schemas/RegistryRegionPatch" }, "description": "Regions is a map of region name (underscore form) to the desired enablement patch.", "type": "object" } }, "type": "object" }, "ProjectSettings": { "description": "ProjectSettings holds all project-level settings groups.", "example": { "connectivity": { "inbound_private_dns": "ibm_cloud_classic_network" }, "entity_tag": "2385407409", "fleet": { "default_network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "default_tasks_state_store": { "persistent_data_store": "my-pds", "sub_path": "my/bucket/data" } }, "logging": { "fleet": { "ingestion_secret": "my-log-secret", "instance_crn": "crn:v1:bluemix:public:logs:us-east:a/4329073d16d2f3663f74bfa955259139:a1b2c3d4-e5f6-7890-abcd-ef1234567890::", "level_agent": "info", "level_worker": "info" } }, "monitoring": { "fleet": { "ingestion_secret": "my-mon-secret", "region": "us-east" }, "standard_metrics": { "app_metrics": "on", "compute_metrics": "off", "enable": "custom", "fleet_metrics": "on", "function_metrics": "on", "gpu_metrics": "on", "job_metrics": "on" } }, "registry": { "regions": { "us_east": { "enablement_status": "enabled", "secret": "ce-auto-icr-private-us-east" } } } }, "properties": { "connectivity": { "$ref": "#/components/schemas/ProjectConnectivitySettings" }, "entity_tag": { "description": "EntityTag is the version of the resource, used for optimistic concurrency control.", "example": "1", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "readOnly": true, "type": "string" }, "fleet": { "$ref": "#/components/schemas/ProjectFleetSettings" }, "logging": { "$ref": "#/components/schemas/ProjectLoggingSettings" }, "monitoring": { "$ref": "#/components/schemas/ProjectMonitoringSettings" }, "registry": { "$ref": "#/components/schemas/ProjectRegistrySettings" } }, "type": "object" }, "ProjectSettingsPatch": { "description": "ProjectSettingsPatch is used to update project-level settings. Only fields present in the request body are updated.", "example": { "connectivity": { "inbound_private_dns": "ibm_cloud_classic_network" }, "fleet": { "default_network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "default_tasks_state_store": { "persistent_data_store": "my-pds", "sub_path": "my/bucket/data" } }, "logging": { "fleet": { "ingestion_secret": "my-log-secret", "instance_crn": "crn:v1:bluemix:public:logs:us-east:a/4329073d16d2f3663f74bfa955259139:a1b2c3d4-e5f6-7890-abcd-ef1234567890::", "level_agent": "info", "level_worker": "info" } }, "monitoring": { "fleet": { "ingestion_secret": "my-mon-secret", "region": "us-east" }, "standard_metrics": { "app_metrics": "on", "compute_metrics": "off", "enable": "custom", "fleet_metrics": "on", "function_metrics": "on", "gpu_metrics": "on", "job_metrics": "on" } }, "registry": { "regions": { "us_east": { "enablement_status": "enabled" }, "us_south": { "enablement_status": "disabled" } } } }, "properties": { "connectivity": { "$ref": "#/components/schemas/ProjectConnectivitySettingsPatch" }, "fleet": { "$ref": "#/components/schemas/ProjectFleetSettingsPatch" }, "logging": { "$ref": "#/components/schemas/ProjectLoggingSettingsPatch" }, "monitoring": { "$ref": "#/components/schemas/ProjectMonitoringSettingsPatch" }, "registry": { "$ref": "#/components/schemas/ProjectRegistrySettingsPatch" } }, "type": "object" }, "ProjectStatusDetails": { "description": "Describes the model of a project status details.", "example": { "cbr": { "data_plane": { "enforcement": "applied", "inbound_private": "allowed", "inbound_public": "allowed", "last_synced_at": "2025-06-30T11:41:35Z" } }, "domain": "ready", "project": "enabled", "vpe": "ready" }, "properties": { "cbr": { "$ref": "#/components/schemas/CbrStatus" }, "domain": { "description": "Status of the domain created for the project.", "enum": [ "unknown", "ready" ], "type": "string" }, "project": { "description": "Defines whether a project is enabled for management and consumption.", "enum": [ "enabled", "disabled" ], "type": "string" }, "vpe": { "description": "Status of the Virtual Private Endpoint that exposes the project on the IBM Cloud private network.", "enum": [ "ready", "unknown" ], "type": "string" }, "vpe_not_enabled": { "description": "Return true when project is not VPE enabled.", "type": "boolean" } }, "required": [ "cbr", "domain", "project", "vpe" ], "type": "object" }, "RegistryRegionPatch": { "description": "RegistryRegionPatch sets the enablement status for a single ICR region.", "example": { "enablement_status": "enabled" }, "properties": { "enablement_status": { "description": "EnablementStatus is \"enabled\" or \"disabled\".", "enum": [ "enabled", "disabled" ], "example": "enabled", "pattern": "^(enabled|disabled)$", "type": "string" } }, "type": "object" }, "RegistryRegionSettings": { "description": "RegistryRegionSettings holds the enablement status and secret name for a single ICR region.", "example": { "enablement_status": "enabled", "secret": "ce-auto-icr-private-us-east" }, "properties": { "enablement_status": { "description": "EnablementStatus is \"enabled\" or \"disabled\".", "enum": [ "enabled", "disabled" ], "example": "enabled", "pattern": "^(enabled|disabled)$", "type": "string" }, "secret": { "description": "Secret is the name of the auto-created ICR secret (read-only, only present when enabled).", "example": "ce-auto-icr-private-us-east", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "readOnly": true, "type": "string" } }, "required": [ "enablement_status" ], "type": "object" }, "RegistrySecretData": { "example": { "email": "email@email.com", "password": "password", "server": "docker.io", "username": "username" }, "properties": { "email": { "description": "Registry email address", "maxLength": 255, "minLength": 0, "pattern": "[\\S]*", "type": "string" }, "password": { "description": "Registry password", "maxLength": 253, "minLength": 1, "pattern": ".*$", "type": "string" }, "server": { "description": "Registry server", "maxLength": 253, "minLength": 1, "pattern": "[\\S]*", "type": "string" }, "username": { "description": "Registry username", "maxLength": 253, "minLength": 1, "pattern": ".*$", "type": "string" } }, "required": [ "username", "password", "server" ], "type": "object" }, "ResourceKeyRef": { "description": "The service credential associated with the secret.", "example": { "id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "name": "my-key" }, "properties": { "id": { "description": "ID of the service credential associated with the secret.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 0, "pattern": "^[a-z0-9][\\-a-z0-9]*[a-z0-9]$", "type": "string" }, "name": { "description": "Name of the service credential associated with the secret.", "type": "string" } }, "type": "object" }, "ResourceKeyRefPrototype": { "description": "The service credential associated with the secret.", "properties": { "id": { "description": "ID of the service credential associated with the secret.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 0, "pattern": "^[a-z0-9][\\-a-z0-9]*[a-z0-9]$", "type": "string" } }, "type": "object" }, "RoleRef": { "description": "A reference to the Role and Role CRN for service binding", "example": { "crn": "crn:v1:bluemix:public:cloud-object-storage::::serviceRole:ContentReader", "name": "Writer" }, "properties": { "crn": { "description": "CRN of the IAM Role for this service access secret", "example": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "maxLength": 253, "minLength": 0, "pattern": "^[A-Z][a-zA-Z() ]*[a-z)]$|^crn\\:v1\\:[a-zA-Z0-9]*\\:(public|dedicated|local)\\:[\\-a-z0-9]*\\:([a-z][\\-a-z0-9_]*[a-z0-9])?\\:((a|o|s)/[\\-a-z0-9]+)?\\:[\\-a-z0-9/]*\\:[\\-a-zA-Z0-9]*(\\:[\\-a-zA-Z0-9/.]*)?$", "type": "string" }, "name": { "default": "Writer", "description": "Role of the service credential.", "example": "Manager", "type": "string" } }, "type": "object" }, "RoleRefPrototype": { "description": "A reference to the Role and Role CRN for service binding", "properties": { "crn": { "description": "CRN of the IAM Role for this service access secret", "example": "crn:v1:bluemix:public:iam::::serviceRole:Writer", "maxLength": 253, "minLength": 0, "pattern": "^[A-Z][a-zA-Z() ]*[a-z)]$|^crn\\:v1\\:[a-zA-Z0-9]*\\:(public|dedicated|local)\\:[\\-a-z0-9]*\\:([a-z][\\-a-z0-9_]*[a-z0-9])?\\:((a|o|s)/[\\-a-z0-9]+)?\\:[\\-a-z0-9/]*\\:[\\-a-zA-Z0-9]*(\\:[\\-a-zA-Z0-9/.]*)?$", "type": "string" } }, "type": "object" }, "SSHSecretData": { "description": "Secret Data field used by SSH secrets.", "example": { "known_hosts": "github.com ssh-ed25519 XXXXXXXXXXXXX", "ssh_key": "-----BEGIN OPENSSH PRIVATE KEY-----XXXXXXXXXXXXX-----END OPENSSH PRIVATE KEY-----" }, "properties": { "known_hosts": { "description": "Known hosts", "maxLength": 1048576, "minLength": 0, "pattern": ".*$", "type": "string" }, "ssh_key": { "description": "SSH key", "maxLength": 1048576, "minLength": 1, "pattern": ".*$", "type": "string" } }, "required": [ "ssh_key" ], "type": "object" }, "Secret": { "description": "Describes the model of a secret.", "example": { "created_at": "2022-11-15T21:59:08+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386255530", "format": "generic", "generated_by": "user", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret", "id": "36e3a621-4895-4bd1-b7e8-1163ab49a28f", "name": "my-secret", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "secret_generic_v2" }, "properties": { "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "readOnly": true, "type": "string" }, "data": { "additionalProperties": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "description": "Data container that allows to specify config parameters and their values as a key-value map. Each key field must consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value field can consists of any character and must not exceed a max length of 1048576 characters.", "type": "object" }, "entity_tag": { "description": "The version of the secret instance, which is used to achieve optimistic locking.", "example": "2385407409", "maxLength": 63, "minLength": 1, "pattern": "^[\\*\\-a-z0-9]+$", "type": "string" }, "format": { "description": "Specify the format of the secret.", "enum": [ "generic", "ssh_auth", "basic_auth", "hmac_auth", "tls", "service_access", "registry", "service_operator", "other" ], "example": "generic", "pattern": "^(generic|ssh_auth|basic_auth|hmac_auth|tls|service_access|registry|service_operator|other)$", "type": "string", "x-terraform-force-new": true }, "generated_by": { "description": "Specifies whether the secret is user generated.", "enum": [ "user", "system" ], "readOnly": true, "type": "string" }, "href": { "description": "When you provision a new secret, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/secrets/my-secret", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the secret.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string", "x-terraform-force-new": true }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string", "x-terraform-force-new": true }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the secret.", "enum": [ "secret_v2", "secret_auth_ssh_v2", "secret_basic_auth_v2", "secret_generic_v2", "secret_operator_v2", "secret_other_v2", "secret_registry_v2", "secret_service_access_v2", "secret_tls_v2", "secret_hmac_auth_v2" ], "readOnly": true, "type": "string" }, "service_access": { "$ref": "#/components/schemas/ServiceAccessSecretProps" }, "service_operator": { "$ref": "#/components/schemas/OperatorSecretProps" } }, "required": [ "created_at", "entity_tag", "id", "project_id", "region", "name", "resource_type", "generated_by", "format" ], "type": "object", "x-data-source-name": "code_engine_secret", "x-data-source-operations": { "read": "get_secret" }, "x-resource-name": "code_engine_secret", "x-resource-operations": { "create": "create_secret", "delete": "delete_secret", "read": "get_secret", "update": "replace_secret" } }, "SecretData": { "additionalProperties": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "description": "Data container that allows to specify config parameters and their values as a key-value map. Each key field must consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value field can consists of any character and must not exceed a max length of 1048576 characters.", "example": { "key-1": "value-1", "key-2": "value-2" }, "oneOf": [ { "$ref": "#/components/schemas/GenericSecretData" }, { "$ref": "#/components/schemas/BasicAuthSecretData" }, { "$ref": "#/components/schemas/RegistrySecretData" }, { "$ref": "#/components/schemas/SSHSecretData" }, { "$ref": "#/components/schemas/HMACAuthSecretData" }, { "$ref": "#/components/schemas/TLSSecretData" } ], "type": "object", "x-terraform-sensitive": true }, "SecretList": { "description": "List of secret resources.", "example": { "limit": 50, "secrets": [ { "created_at": "2022-11-15T21:59:08+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386255530", "format": "generic", "generated_by": "user", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret", "id": "36e3a621-4895-4bd1-b7e8-1163ab49a28f", "name": "my-secret", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "secret_generic_v2" } ] }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" }, "secrets": { "description": "List of secrets.", "items": { "$ref": "#/components/schemas/Secret" }, "maxItems": 500, "minItems": 0, "type": "array" } }, "required": [ "secrets", "limit" ], "type": "object" }, "SecretPatch": { "description": "Request model for secret patches.", "example": { "data": { "MY_PROPERTY": "OTHER" }, "format": "generic" }, "properties": { "data": { "$ref": "#/components/schemas/SecretData" }, "format": { "description": "Specify the format of the secret. The format of the secret will determine how the secret is used.", "enum": [ "generic", "ssh_auth", "basic_auth", "hmac_auth", "tls", "service_access", "registry", "service_operator", "other" ], "example": "generic", "pattern": "^(generic|ssh_auth|basic_auth|hmac_auth|tls|service_access|registry|service_operator|other)$", "type": "string", "x-terraform-force-new": true } }, "required": [ "format" ], "type": "object" }, "SecretPrototype": { "description": "Request model for secret objects.", "example": { "data": { "MY_PROPERTY": "VALUE" }, "format": "generic", "name": "my-secret" }, "properties": { "data": { "$ref": "#/components/schemas/SecretData" }, "format": { "description": "Specify the format of the secret. The format of the secret will determine how the secret is used.", "enum": [ "generic", "ssh_auth", "basic_auth", "hmac_auth", "tls", "service_access", "registry", "service_operator", "other" ], "example": "generic", "pattern": "^(generic|ssh_auth|basic_auth|hmac_auth|tls|service_access|registry|service_operator|other)$", "type": "string", "x-terraform-force-new": true }, "name": { "description": "The name of the secret.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "service_access": { "$ref": "#/components/schemas/ServiceAccessSecretPrototypeProps" }, "service_operator": { "$ref": "#/components/schemas/OperatorSecretPrototypeProps" } }, "required": [ "name", "format" ], "type": "object" }, "ServiceAccessSecretProps": { "description": "Properties for Service Access Secrets", "properties": { "resource_key": { "$ref": "#/components/schemas/ResourceKeyRef" }, "role": { "$ref": "#/components/schemas/RoleRef" }, "service_instance": { "$ref": "#/components/schemas/ServiceInstanceRef" }, "serviceid": { "$ref": "#/components/schemas/ServiceIDRef" } }, "required": [ "service_instance" ], "type": "object", "x-terraform-force-new": true }, "ServiceAccessSecretPrototypeProps": { "description": "Properties for Service Access Secrets", "properties": { "resource_key": { "$ref": "#/components/schemas/ResourceKeyRefPrototype" }, "role": { "$ref": "#/components/schemas/RoleRefPrototype" }, "service_instance": { "$ref": "#/components/schemas/ServiceInstanceRefPrototype" }, "serviceid": { "$ref": "#/components/schemas/ServiceIDRef" } }, "required": [ "service_instance" ], "type": "object" }, "ServiceIDRef": { "description": "A reference to a Service ID", "properties": { "crn": { "description": "CRN value of a Service ID", "maxLength": 253, "minLength": 0, "pattern": "^crn\\:v1\\:[a-zA-Z0-9]*\\:(public|dedicated|local)\\:[\\-a-z0-9]*\\:([a-z][\\-a-z0-9_]*[a-z0-9])?\\:((a|o|s)/[\\-a-z0-9]+)?\\:[\\-a-z0-9/]*\\:[\\-a-zA-Z0-9]*(\\:[\\-a-zA-Z0-9/.]*)?$", "type": "string" }, "id": { "description": "The ID of the Service ID", "example": "ServiceId-8fa4bc74-6441-4e5b-af3a-2b1af325a637", "maxLength": 46, "minLength": 46, "pattern": "^ServiceId-[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, "type": "object" }, "ServiceIDRefPrototype": { "description": "A reference to the Service ID", "properties": { "id": { "description": "The ID of the Service ID", "example": "ServiceId-8fa4bc74-6441-4e5b-af3a-2b1af325a637", "maxLength": 46, "minLength": 46, "pattern": "^ServiceId-[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, "type": "object" }, "ServiceInstanceRef": { "description": "The IBM Cloud service instance associated with the secret.", "example": { "id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "type": "appid" }, "properties": { "id": { "description": "ID of the IBM Cloud service instance associated with the secret.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[a-z0-9][\\-a-z0-9]*[a-z0-9]$", "type": "string" }, "type": { "description": "Type of IBM Cloud service associated with the secret.", "maxLength": 253, "minLength": 1, "pattern": "^.*$", "type": "string" } }, "type": "object" }, "ServiceInstanceRefPrototype": { "description": "The IBM Cloud service instance associated with the secret.", "properties": { "id": { "description": "ID of the IBM Cloud service instance associated with the secret.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[a-z0-9][\\-a-z0-9]*[a-z0-9]$", "type": "string" } }, "type": "object" }, "StandardMetricsSettings": { "description": "StandardMetricsSettings controls which resource types emit metrics.", "example": { "app_metrics": "on", "compute_metrics": "off", "enable": "custom", "fleet_metrics": "on", "function_metrics": "on", "gpu_metrics": "on", "job_metrics": "on" }, "properties": { "app_metrics": { "description": "AppMetrics controls app metrics: \"off\" or \"on\".", "enum": [ "off", "on" ], "example": "on", "pattern": "^(off|on)$", "type": "string" }, "compute_metrics": { "description": "ComputeMetrics controls compute metrics: \"off\" or \"on\".", "enum": [ "off", "on" ], "example": "on", "pattern": "^(off|on)$", "type": "string" }, "enable": { "description": "Enable controls overall metrics collection: \"all\", \"none\", or \"custom\".", "enum": [ "all", "none", "custom" ], "example": "all", "pattern": "^(all|none|custom)$", "type": "string" }, "fleet_metrics": { "description": "FleetMetrics controls fleet metrics: \"off\" or \"on\".", "enum": [ "off", "on" ], "example": "on", "pattern": "^(off|on)$", "type": "string" }, "function_metrics": { "description": "FunctionMetrics controls function metrics: \"off\" or \"on\".", "enum": [ "off", "on" ], "example": "on", "pattern": "^(off|on)$", "type": "string" }, "gpu_metrics": { "description": "GpuMetrics controls GPU metrics: \"off\" or \"on\".", "enum": [ "off", "on" ], "example": "on", "pattern": "^(off|on)$", "type": "string" }, "job_metrics": { "description": "JobMetrics controls job metrics: \"off\" or \"on\".", "enum": [ "off", "on" ], "example": "on", "pattern": "^(off|on)$", "type": "string" } }, "required": [ "app_metrics", "compute_metrics", "enable", "fleet_metrics", "function_metrics", "gpu_metrics", "job_metrics" ], "type": "object" }, "StorageData": { "additionalProperties": { "maxLength": 1048576, "minLength": 0, "pattern": "^.*$", "type": "string" }, "description": "Data container that allows to specify config parameters and their values as a key-value map. Each key field must consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value field can consists of any character and must not exceed a max length of 1048576 characters.", "example": { "bucket_location": "eu-de", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "oneOf": [ { "$ref": "#/components/schemas/ObjectStorageData" } ], "type": "object" }, "SubnetPool": { "description": "Describes the model of a subnet pool.", "example": { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools/b5e300ed-50c9-4775-b29c-03f6a67ac41f", "id": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "name": "subnet-pool-eu-de-1", "pool": [ { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "subnet_pool_v2" }, "properties": { "created_at": { "description": "The timestamp when the resource was created.", "example": "2022-09-13T11:41:35+02:00", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "href": { "description": "When you provision a new subnet pool, a URL is created identifying the location of the instance.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/subnet_pools/my-subnet-pool-eu-de-1", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the subnet pool.", "example": "my-subnet-pool-eu-de-1", "maxLength": 127, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "pool": { "description": "List of referenced subnets and security groups.", "items": { "$ref": "#/components/schemas/SubnetPoolReference" }, "maxItems": 100, "minItems": 1, "type": "array" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "maxLength": 63, "minLength": 5, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the subnet pool.", "enum": [ "subnet_pool_v2" ], "readOnly": true, "type": "string" } }, "required": [ "created_at", "href", "id", "name", "pool", "project_id", "region", "resource_type" ], "type": "object" }, "SubnetPoolList": { "description": "Contains a list of subnet pools and pagination information.", "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools?limit=50" }, "limit": 50, "subnet_pools": [ { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools/b5e300ed-50c9-4775-b29c-03f6a67ac41f", "id": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "name": "subnet-pool-eu-de-1", "pool": [ { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "subnet_pool_v2" } ] }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" }, "subnet_pools": { "description": "List of all subnet pools.", "items": { "$ref": "#/components/schemas/SubnetPool" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "required": [ "limit", "subnet_pools" ], "type": "object" }, "SubnetPoolPrototype": { "description": "Property values for the new subnet pool resource instance", "example": { "name": "subnet-pool-eu-de-1", "pool": [ { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" } ] }, "properties": { "name": { "description": "The name of the subnet pool. Use a name that is unique within the project.", "example": "my-subnet-pool-eu-de-1", "maxLength": 127, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "pool": { "description": "List of referenced subnets and security groups.", "items": { "$ref": "#/components/schemas/SubnetPoolReferencePrototype" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "name", "pool" ], "type": "object" }, "SubnetPoolReference": { "example": { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" }, "properties": { "security_group_crns": { "description": "List of CRNs referencing a security groups from an existing VPC network.", "example": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "items": { "maxLength": 512, "minLength": 17, "pattern": "^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\./]*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "subnet_crn": { "description": "The CRN referencing a subnet from an existing VPC network.", "example": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "maxLength": 512, "minLength": 17, "pattern": "^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\./]*$", "type": "string" } }, "required": [ "security_group_crns", "subnet_crn" ], "type": "object" }, "SubnetPoolReferencePrototype": { "example": { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" }, "properties": { "security_group_crns": { "description": "List of CRNs referencing a security groups from an existing VPC network. The CRN in the account has to match the account in the subnet CRN and the project account information.\nIn case no security groups are provided, the system will use the default security groups of the VPC.", "example": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "items": { "maxLength": 512, "minLength": 17, "pattern": "^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\./]*$", "type": "string" }, "maxItems": 100, "minItems": 0, "type": "array" }, "subnet_crn": { "description": "The CRN referencing a subnet from an existing VPC network. The CRN in the account has to match the project account information.", "example": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "maxLength": 512, "minLength": 17, "pattern": "^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\./]*$", "type": "string" } }, "required": [ "subnet_crn" ], "type": "object" }, "TLSSecretData": { "example": { "tls_cert": "---BEGIN CERTIFICATE---XXXXXXXXXXXXX---END CERTIFICATE---", "tls_key": "---BEGIN PRIVATE KEY---XXXXXXXXXXXXX---END PRIVATE KEY---" }, "properties": { "tls_cert": { "description": "The TLS certificate used in a TLS secret", "maxLength": 1048576, "minLength": 1, "pattern": "^---+BEGIN CERTIFICATE---+[\\s\\S]*---+END CERTIFICATE---+[\\s\\S]*$", "type": "string" }, "tls_key": { "description": "The TLS key used in a TLS secret", "maxLength": 1048576, "minLength": 1, "pattern": "^---+BEGIN[A-Z\\s]*PRIVATE KEY---+[\\s\\S]*---+END[A-Z\\s]*PRIVATE KEY---+[\\s\\S]*$", "type": "string" } }, "required": [ "tls_cert", "tls_key" ], "type": "object" }, "Task": { "description": "Describes a fleet task.", "example": { "created_at": "2025-03-13T11:41:35Z", "finished_at": "2025-03-13T13:41:35Z", "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks/ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "id": "ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "index": "1", "process_id": "93375", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_task_v2", "retries": 1, "status": "succeeded", "worker_name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0" }, "properties": { "created_at": { "description": "The timestamp when the task was initially created.", "example": "2025-09-01T11:50:00Z", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "finished_at": { "description": "The timestamp when the resource finished.", "example": "2022-09-13T11:41:35+02:00", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "fleet_id": { "description": "The ID of the fleet as part of which the task is processing tasks.", "example": "5ca21889-9824-4004-a94d-4f35b119ca7d", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "href": { "description": "URL identifying the location of the task.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/fleets/e33b1cv7-7390-4437-a5c2-130d5ccdddc3/tasks/3af87ebb-4480-43f2-aad3-73d0d2328f30", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "index": { "description": "Indicating the index that is provided to the task for reference.", "example": "1", "maxLength": 63, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" }, "process_id": { "description": "The ID of the process on the worker which is processing the task.", "example": "37414", "maxLength": 32, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "maxLength": 63, "minLength": 5, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the fleet task status.", "enum": [ "fleet_task_v2" ], "readOnly": true, "type": "string" }, "retries": { "description": "Number of performed retries to finish task processing.", "example": 0, "format": "int32", "maximum": 255, "minimum": 0, "readOnly": true, "type": "integer" }, "started_at": { "description": "The timestamp when the task started processing.", "example": "2025-09-01T11:50:00Z", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "status": { "description": "Current status of the fleet task.", "enum": [ "pending", "running", "succeeded", "failed", "canceled" ], "example": "running", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/TaskStatusDetails" }, "worker_name": { "description": "The name of the worker that is processing task.", "example": "fleet-5ca21889-9824-4004-a94d-4f35b119ca7d-1", "maxLength": 64, "minLength": 0, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "readOnly": true, "type": "string" } }, "required": [ "id", "project_id", "region", "index", "fleet_id", "resource_type", "status" ], "type": "object" }, "TaskList": { "description": "Describes the result of a fleet task statue list operation.", "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks_by_status/finished?limit=50" }, "limit": 50, "next": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks_by_status/finished?limit=50&start=eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ", "start": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ" }, "tasks": [ { "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks/ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "id": "ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "index": "1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_task_v2", "status": "running", "worker_name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0" } ] }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" }, "tasks": { "description": "Collection of fleet task statuses.", "items": { "$ref": "#/components/schemas/TaskSummary" }, "maxItems": 1000, "minItems": 0, "readOnly": true, "type": "array" } }, "required": [ "tasks", "limit" ], "type": "object" }, "TaskProgress": { "description": "The task progress the fleet has made.", "example": { "canceled": 0, "failed": 5, "pending": 20, "running": 50, "succeeded": 130 }, "properties": { "canceled": { "description": "The number of failed canceled in the fleet.", "example": 1, "format": "int64", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "failed": { "description": "The number of failed tasks in the fleet.", "example": 2, "format": "int64", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "pending": { "description": "The number of pending tasks in the fleet.", "example": 5, "format": "int64", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "running": { "description": "The number of running tasks in the fleet.", "example": 10, "format": "int32", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "succeeded": { "description": "The number of succeeded tasks in the fleet.", "example": 23, "format": "int64", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" }, "total": { "description": "The total number of tasks in the fleet.", "example": 100, "format": "int64", "maximum": 9999999, "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "pending", "running", "failed", "succeeded", "canceled" ], "type": "object" }, "TaskStateStore": { "description": "The reference to the object store where the task progress is maintained.", "example": { "persistent_data_store": "my-persistent-data-store", "sub_path": "/my/bucket/data" }, "properties": { "persistent_data_store": { "description": "Name of referenced persistent data store resource.", "example": "my-fleet-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "readOnly": true, "type": "string" }, "sub_path": { "description": "Optional object storage prefix to be used as an entry point.", "example": "/my/bucket/data/", "maxLength": 1000, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "persistent_data_store" ], "type": "object" }, "TaskStateStorePrototype": { "description": "The reference to the object store where the task progress is maintained.", "example": { "persistent_data_store": "my-persistent-data-store", "sub_path": "/my/bucket/data" }, "properties": { "persistent_data_store": { "description": "Name of referenced persistent data store resource.", "example": "my-fleet-data-store", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "sub_path": { "description": "Optional object storage prefix to be used as an entry point.", "example": "/my/bucket/data/", "maxLength": 1000, "minLength": 1, "pattern": "^.+$", "type": "string" } }, "required": [ "persistent_data_store" ], "type": "object" }, "TaskStatusDetails": { "description": "Current status of the fleet task.", "example": { "reason": "error_exit_1" }, "properties": { "reason": { "description": "Code giving more information on failure reason of task.", "example": "error_exit_1", "maxLength": 63, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" } }, "type": "object" }, "TaskSummary": { "description": "Describes a task status.", "example": { "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks/ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "id": "ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "index": "1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_task_v2", "status": "running", "worker_id": "6d0cd963-55c9-465e-bb92-032c0e3de3f4" }, "properties": { "batch_name": { "description": "Name of the batch the task belongs to.", "example": "my-run-123", "maxLength": 256, "minLength": 0, "pattern": "^[^/]*$", "readOnly": true, "type": "string" }, "created_at": { "description": "Timestamp of the creation of the fleet task.", "example": "2021-08-10T14:00:00Z", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "finished_at": { "description": "Timestamp of when the fleet task processing finished in the worker.", "example": "2021-08-10T14:00:00Z", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "fleet_id": { "description": "The ID of the fleet as part of which the task is processing tasks.", "example": "5ca21889-9824-4004-a94d-4f35b119ca7d", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "href": { "description": "URL identifying the location of the task.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/fleets/e33b1cv7-7390-4437-a5c2-130d5ccdddc3/tasks/3af87ebb-4480-43f2-aad3-73d0d2328f30", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The unique identifier of the resource.", "example": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "index": { "description": "Indicating the index that is provided to the task for reference.", "example": "1", "maxLength": 63, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "5ca21889-9824-4004-a94d-4f35b119ca7d", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in.", "enum": [ "au-syd", "br-sao", "ca-tor", "eu-de", "eu-es", "eu-gb", "in-che", "jp-osa", "jp-tok", "us-east", "us-south" ], "example": "us-east", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the fleet task status.", "enum": [ "fleet_task_v2" ], "readOnly": true, "type": "string" }, "retries": { "description": "Number of performed retries to finish task processing.", "example": 0, "format": "int32", "maximum": 255, "minimum": 0, "readOnly": true, "type": "integer" }, "started_at": { "description": "Timestamp when the fleet task was started to be processed in the worker.", "example": "2021-08-10T14:00:00Z", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "status": { "description": "Current status of the fleet task.", "enum": [ "pending", "running", "succeeded", "failed", "canceled" ], "example": "running", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/TaskSummaryStatusDetails" }, "worker_name": { "description": "The name of the worker that is processing task.", "example": "fleet-5ca21889-9824-4004-a94d-4f35b119ca7d-1", "maxLength": 64, "minLength": 0, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "readOnly": true, "type": "string" } }, "required": [ "fleet_id", "href", "id", "index", "project_id", "region", "resource_type", "status" ], "type": "object" }, "TaskSummaryStatusDetails": { "description": "Current status of the fleet task.", "example": { "result_code": "1" }, "properties": { "result_code": { "description": "Code giving more information on failure reason of task.", "example": "1", "maxLength": 32, "minLength": 1, "pattern": "^.+$", "readOnly": true, "type": "string" } }, "type": "object" }, "TasksSpecification": { "example": { "indices": "0-99" }, "oneOf": [ { "$ref": "#/components/schemas/IndicesTaskSource" }, { "$ref": "#/components/schemas/CosBucket" }, { "$ref": "#/components/schemas/JsonReference" } ], "type": "object" }, "TasksSpecificationPrototype": { "description": "The source of task that are processed by the fleet.", "example": { "indices": "0-99" }, "oneOf": [ { "$ref": "#/components/schemas/IndicesTaskSourcePrototype" }, { "$ref": "#/components/schemas/CosBucketPrototype" }, { "$ref": "#/components/schemas/JsonReferencePrototype" }, { "$ref": "#/components/schemas/JsonTaskPrototype" } ], "type": "object" }, "TasksStateStoreSettings": { "description": "TasksStateStoreSettings identifies the PersistentDataStore and optional sub-path for fleet task state.", "example": { "persistent_data_store": "my-pds", "sub_path": "my/bucket/data" }, "properties": { "persistent_data_store": { "description": "PersistentDataStore is the name of the PersistentDataStore resource.", "example": "my-pds", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "sub_path": { "description": "SubPath is the optional sub-path within the data store.", "example": "my/bucket/data", "maxLength": 256, "minLength": 1, "pattern": "^([^\\/\\0]+\\/?)+$", "type": "string" } }, "type": "object" }, "VolumeMount": { "description": "Response model of a volume mount.", "example": { "mount_path": "/app", "name": "codeengine-mount-b69u90", "reference": "my-secret", "type": "secret" }, "properties": { "mount_path": { "description": "The path that should be mounted.", "example": "/app", "maxLength": 256, "minLength": 1, "pattern": "^\\/([^\\/\\0]+\\/?)+$", "type": "string" }, "read_only": { "description": "Optional flag for a volume mount of type 'persistent_data_store' to specify whether it is read-only.", "example": true, "type": "boolean" }, "reference": { "description": "The name of the referenced secret, config map, or persistent data store.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "sub_path": { "description": "The path mounted at the mount path.", "example": "some-path", "maxLength": 1000, "minLength": 1, "pattern": "^.+$", "type": "string" }, "type": { "default": "secret", "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'persistent_data_store', 'secret'.", "enum": [ "config_map", "persistent_data_store", "secret" ], "example": "secret", "pattern": "^(config_map|persistent_data_store|secret)$", "type": "string" } }, "required": [ "mount_path", "reference", "type" ], "type": "object" }, "VolumeMountPrototype": { "description": "Prototype model of a volume mount.", "example": { "mount_path": "/app", "reference": "my-secret", "type": "secret" }, "properties": { "mount_path": { "description": "The path that should be mounted.", "example": "/app", "maxLength": 256, "minLength": 1, "pattern": "^\\/([^\\/\\0]+\\/?)+$", "type": "string" }, "read_only": { "description": "Optional flag for a volume mount of type 'persistent_data_store' to specify whether it is read-only.", "example": true, "type": "boolean" }, "reference": { "description": "The name of the referenced secret, config map, or persistent data store.", "example": "my-secret", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "sub_path": { "description": "The path mounted at the mount path.", "example": "some-path", "maxLength": 1000, "minLength": 1, "pattern": "^.+$", "type": "string" }, "type": { "default": "secret", "description": "Specify the type of the volume mount. Allowed types are: 'config_map', 'persistent_data_store', 'secret'.", "enum": [ "config_map", "persistent_data_store", "secret" ], "example": "secret", "pattern": "^(config_map|persistent_data_store|secret)$", "type": "string" } }, "required": [ "mount_path", "reference", "type" ], "type": "object" }, "Worker": { "description": "Describes the model of a fleet worker.", "example": { "created_at": "2025-03-13T11:41:35Z", "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers/fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "id": "6d0cd963-55c9-465e-bb92-032c0e3de3f4", "name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_worker_v2", "status": "running", "status_details": { "address": "10.244.0.4", "image_version": "v1.0.15", "profile": "gx2-8x64x1v100", "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "zone": "eu-de-1" } }, "properties": { "created_at": { "description": "The timestamp when the resource was created.", "example": "2025-09-01T11:50:00Z", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "finished_at": { "description": "The timestamp when the worker finished.", "example": "2025-09-01T12:00:00Z", "maxLength": 63, "minLength": 5, "pattern": "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(Z|[\\+-]\\d{2}:\\d{2})?)$", "readOnly": true, "type": "string" }, "fleet_id": { "description": "The ID of the fleet as part of which the worker is processing tasks.", "example": "5ca21889-9824-4004-a94d-4f35b119ca7d", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "href": { "description": "URL identifying the location of the worker.", "example": "https://api.eu-de.codeengine.cloud.ibm.com/v2/projects/4e49b3e0-27a8-48d2-a784-c7ee48bb863b/fleets/e33b1cv7-7390-4437-a5c2-130d5ccdddc3/workers/3af87ebb-4480-43f2-aad3-73d0d2328f30", "maxLength": 2048, "minLength": 0, "pattern": "^(([^:\\/?#]+):)?(//([^\\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$", "readOnly": true, "type": "string" }, "id": { "description": "The identifier of the resource.", "example": "e33b1cv7-7390-4437-a5c2-130d5ccdddc3", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "name": { "description": "The name of the worker.", "example": "fleet-5ca21889-9824-4004-a94d-4f35b119ca7d-1", "maxLength": 64, "minLength": 0, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "readOnly": true, "type": "string" }, "project_id": { "description": "The ID of the project in which the resource is located.", "example": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "readOnly": true, "type": "string" }, "region": { "description": "The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.", "example": "us-east", "maxLength": 63, "minLength": 5, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", "readOnly": true, "type": "string" }, "resource_type": { "description": "The type of the fleet worker.", "enum": [ "fleet_worker_v2" ], "readOnly": true, "type": "string" }, "status": { "description": "Current status of the fleet worker.", "enum": [ "pending", "initializing", "running", "stopping", "stopped", "failed", "deleting" ], "example": "running", "readOnly": true, "type": "string" }, "status_details": { "$ref": "#/components/schemas/WorkerStatusDetails" } }, "required": [ "fleet_id", "href", "id", "name", "project_id", "region", "resource_type", "status", "status_details" ], "type": "object" }, "WorkerList": { "description": "Describes the result of a fleet workers list operation.", "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers?limit=50" }, "limit": 50, "next": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers?limit=50&start=eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ", "start": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ" }, "workers": [ { "created_at": "2025-03-13T11:41:35Z", "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers/fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "id": "6d0cd963-55c9-465e-bb92-032c0e3de3f4", "name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_worker_v2", "status": "running", "status_details": { "address": "10.244.0.4", "image_version": "v1.0.15", "profile": "gx2-8x64x1v100", "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "zone": "eu-de-1" } } ] }, "properties": { "first": { "$ref": "#/components/schemas/ListFirstMetadata" }, "limit": { "default": 50, "description": "Maximum number of resources per page.", "example": 100, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "next": { "$ref": "#/components/schemas/ListNextMetadata" }, "workers": { "description": "Collection of fleet workers.", "items": { "$ref": "#/components/schemas/Worker" }, "maxItems": 500, "minItems": 0, "readOnly": true, "type": "array" } }, "required": [ "workers", "limit" ], "type": "object" }, "WorkerStatusDetails": { "description": "Information around the network and configuration details of the worker.", "example": { "address": "10.0.1.5", "image_version": "v1.0.22", "profile": "gx2-8x64x1v100", "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "zone": "eu-de-1" }, "properties": { "address": { "description": "Address at which the worker is accessible.", "example": "10.0.1.5", "maxLength": 64, "minLength": 0, "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", "readOnly": true, "type": "string" }, "image_version": { "description": "Version of the VSI base image used for this worker", "example": "v0.0.56", "maxLength": 12, "minLength": 0, "pattern": "^v(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)$", "readOnly": true, "type": "string" }, "profile": { "description": "The type of the fleet worker.", "example": "gx2-8x64x1v100", "maxLength": 64, "minLength": 0, "pattern": "^([a-z0-9]{3,5}-[0-9]+x[0-9]+(x[a-z0-9]+)?)$", "readOnly": true, "type": "string" }, "subnet_crn": { "description": "The CRN of the subnet the worker is connecting to.", "example": "crn:v1:bluemix:public:is:eu-de-2:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "maxLength": 512, "minLength": 17, "pattern": "^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\./]*$", "readOnly": true, "type": "string" }, "zone": { "description": "Availability zone the fleet worker is located in.", "example": "eu-de-1", "maxLength": 32, "minLength": 0, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$", "readOnly": true, "type": "string" } }, "required": [ "subnet_crn", "profile", "zone" ], "type": "object" } }, "securitySchemes": { "Bearer": { "bearerFormat": "JWT", "description": "\"Type 'Bearer TOKEN'\"", "scheme": "bearer", "type": "http" } } }, "info": { "contact": {}, "description": "## Introduction\n\nIBM Cloud Code Engine provides a platform to unify the deployment of functions, applications, and pre-built containers to a Kubernetes-based infrastructure, enabling higher productivity and a faster time to market. Code Engine is built on open-source projects such as Kubernetes, Istio, Knative, and Tekton. For more information about custom resource definition methods that are available to use with Code Engine, see [API reference](https://cloud.ibm.com/docs/codeengine?topic=codeengine-api).\n\nThe `curl` examples require a bearer token. You can retrieve a token with the following command.\n\n```shell\nibmcloud iam oauth-tokens --output json\n```\n\nYou can also use `jq` to get clean output.\n\n```shell\ntoken=`ibmcloud iam oauth-tokens --output json | jq .iam_token -r`\n```\n\nThese code examples use the client library that is provided for Java.\n\nMaven\n\n```xml\n\n com.ibm.cloud\n code-engine\n 0.3.3\n\n```\n\nGitHub\n\n

\n https://github.com/IBM/code-engine-java-sdk\n

\n\nThese code examples use the client library that is provided for Node.js.\n\nInstallation\n\n```sh\nnpm install ibm-code-engine-sdk\n```\n\nGitHub\n\n

\n https://github.com/IBM/code-engine-node-sdk\n

\n\nThese code examples use the client library that is provided for Python.\n\nInstallation\n\n```sh\npip install --upgrade \"ibm-code-engine-sdk\"\n```\n\nGitHub\n\n

\n https://github.com/IBM/code-engine-python-sdk\n

\n\nThese code examples use the client library that is provided for Go.\n\n```bash\ngo get -u github.com/IBM/code-engine-go-sdk\n```\n\nGitHub\n\n

\n https://github.com/IBM/code-engine-go-sdk\n

\n\n## Authentication\n\nYou can create and manage Identity and Access Management (IAM)-based projects in Code Engine. IAM-based projects are created in resource groups and are managed with IAM access policies.\n\nThis API requires IBM Cloud Identity and Access Management (IAM) authentication. You can retrieve your IAM access token by running `ibmcloud iam oauth-tokens`. You must pass the IAM token in the `Authorization` header.\n\nFor specific information about using IAM with Code Engine APIs, see the [API reference](https://cloud.ibm.com/docs/codeengine?topic=codeengine-api).\n\n## Endpoint URLs\n\nThe endpont URLs are based on the location of the service instance. For example, when Code Engine is hosted in Dallas, TX, the base URL is https://api.us-south.codeengine.cloud.ibm.com.\n\nTo find out which URL to use, view the service credentials by clicking the service instance in the Resource list. Use that URL in your requests to Code Engine.\n\nAll locations might not support Code Engine. For more information, see [Regions](https://cloud.ibm.com/docs/codeengine?topic=codeengine-regions).\n\n## Error handling\n\nThis API uses standard HTTP response codes to indicate whether a method completed successfully. A `200` response always indicates success. A `400` type response is some sort of failure, and a `500` type response usually indicates an internal system error.\n\n| HTTP error code | Description | Recovery |\n| --------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `200` | Success | The request was successful. |\n| `400` | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |\n| `401` | Unauthorized | You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions. |\n| `403` | Forbidden | The supplied authentication is not authorized to access '{project}'. Check that you have the correct access credentials and permissions. |\n| `404` | Not Found | The requested resource could not be found. Check that the namespace ID is correct and try again. |\n| `408` | Request Timeout | The connection to the server timed out. Wait a few minutes, then try again. |\n| `409` | Conflict | The entity is already in the requested state. |\n| `500` | Internal Server Error | IBM Cloud Code Engine is currently unavailable. Your request could not be processed. Please wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact the IBM Cloud support. |\n\n## Versioning\n\nAPI requests can have a version parameter that takes a date in the format `version=YYYY-MM-DD`. When the API is updated with any breaking changes, the service introduces a new version date for the API.\nSend the version parameter with every API request. The API uses the most recent version on or before the date you specify. Don't default to the current date. Instead, specify a date that matches a version that is compatible with your application, and don't change it until your application is ready for a later version. If you do not provide a date, the API uses a date of `2022-12-09` which defaults to version `2.0.0`.", "title": "Code Engine", "version": "2.0.0", "x-codegen-config": { "go": { "apiPackage": "github.com/IBM/code-engine-go-sdk" }, "java": { "apiPackage": "github.com/IBM/code-engine-java-sdk" }, "node": { "apiPackage": "github.com/IBM/code-engine-node-sdk" }, "python": { "apiPackage": "github.com/IBM/code-engine-python-sdk" } }, "x-sdk-supported-languages": [ "curl", "go", "java", "node", "python" ], "x-github": "https://github.ibm.com/cloud-api-docs/codeengine", "x-github-issues": "https://github.ibm.com/cloud-api-docs/codeengine/issues/new", "x-last-updated": "2026-10-12" }, "openapi": "3.0.0", "paths": { "/function_runtimes": { "get": { "description": "List all valid function runtimes.", "operationId": "list_function_runtimes", "responses": { "200": { "content": { "application/json": { "example": { "function_runtimes": [ { "default": true, "deprecated": false, "family": "nodejs", "id": "nodejs-22", "name": "Node.js 22", "optimized": true }, { "default": false, "deprecated": false, "family": "nodejs", "id": "nodejs-24", "name": "Node.js 24", "optimized": true }, { "default": true, "deprecated": false, "family": "python", "id": "python-3.13", "name": "Python 3.13", "optimized": true } ] }, "schema": { "$ref": "#/components/schemas/FunctionRuntimeList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List the function runtimes", "tags": [ "Functions" ], "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/function_runtimes?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listFunctionRuntimesOptions := codeEngineService.NewListFunctionRuntimesOptions()\n", "\n", "functionRuntimeList, response, err := codeEngineService.ListFunctionRuntimes(listFunctionRuntimesOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(functionRuntimeList, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListFunctionRuntimesOptions listFunctionRuntimesOptions = new ListFunctionRuntimesOptions();\n", "\n", "Response response = codeEngineService.listFunctionRuntimes(listFunctionRuntimesOptions).execute();\n", "FunctionRuntimeList functionRuntimeList = response.getResult();\n", "\n", "System.out.println(functionRuntimeList);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "let res;\n", "try {\n", " res = await codeEngineService.listFunctionRuntimes({});\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.list_function_runtimes()\n", "function_runtime_list = response.get_result()\n", "\n", "print(json.dumps(function_runtime_list, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects": { "get": { "description": "List all projects in the current account.", "operationId": "list_projects", "parameters": [ { "description": "Optional maximum number of projects per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. Any additional query parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "limit": 50, "projects": [ { "account_id": "f9f1030ebf674eda8d57bdbc2b9e536a", "created_at": "2021-03-29T12:18:13.992359829Z", "crn": "crn:v1:bluemix:public:codeengine:us-east:a/4329073d16d2f3663f74bfa955259139:15314cc3-85b4-4338-903f-c28cdee6d005::", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005", "id": "15314cc3-85b4-4338-903f-c28cdee6d005", "name": "test_project", "region": "us-east", "resource_group_id": "b91e849cedb04e7e92bd68c040c672dc", "resource_type": "project_v2", "status": "active" } ] }, "schema": { "$ref": "#/components/schemas/ProjectList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List all projects", "tags": [ "Projects" ], "x-ibm-permissions": { "actions": [ { "name": "resource-controller.instance.retrieve" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listProjectsOptions := &codeenginev2.ListProjectsOptions{\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewProjectsPager(listProjectsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.Project\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListProjectsOptions listProjectsOptions = new ListProjectsOptions.Builder()\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "ProjectsPager pager = new ProjectsPager(codeEngineService, listProjectsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.ProjectsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = ProjectsPager(\n", " client=code_engine_service,\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a Code Engine project on IBM Cloud. The project will be created in the region that corresponds to the API endpoint that is being called.", "operationId": "create_project", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPrototype" } } }, "description": "Project prototype", "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "account_id": "f9f1030ebf674eda8d57bdbc2b9e536a", "created_at": "2021-03-29T12:18:13.992359829Z", "crn": "crn:v1:bluemix:public:codeengine:us-east:a/4329073d16d2f3663f74bfa955259139:15314cc3-85b4-4338-903f-c28cdee6d005::", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005", "id": "15314cc3-85b4-4338-903f-c28cdee6d005", "name": "test_project", "region": "us-east", "resource_group_id": "b91e849cedb04e7e92bd68c040c672dc", "resource_type": "project_v2", "status": "active" }, "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a project", "tags": [ "Projects" ], "x-codegen-request-body-name": "Project", "x-ibm-events": { "events": [ { "name": "resource-controller.instance.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "resource-controller.instance.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"test_project\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createProjectOptions := codeEngineService.NewCreateProjectOptions(\n", " \"my-project\",\n", ")\n", "\n", "project, response, err := codeEngineService.CreateProject(createProjectOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(project, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateProjectOptions createProjectOptions = new CreateProjectOptions.Builder()\n", " .name(\"my-project\")\n", " .build();\n", "\n", "Response response = codeEngineService.createProject(createProjectOptions).execute();\n", "Project project = response.getResult();\n", "\n", "System.out.println(project);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " name: 'my-project',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createProject(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_project(\n", " name='my-project',\n", ")\n", "project = response.get_result()\n", "\n", "print(json.dumps(project, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } }, "x-terraform-polling-delay": 20, "x-terraform-polling-failure": [ "creation_failed" ], "x-terraform-polling-operation": "get_project", "x-terraform-polling-pending": [ "creating", "preparing" ], "x-terraform-polling-property": "status", "x-terraform-polling-success": "active", "x-terraform-polling-timeout": 600 } }, "/projects/{id}": { "delete": { "description": "Delete a project.", "operationId": "delete_project", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a project", "tags": [ "Projects" ], "x-ibm-events": { "events": [ { "name": "resource-controller.instance.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "resource-controller.instance.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteProjectOptions := codeEngineService.NewDeleteProjectOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteProject(deleteProjectOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteProject(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteProjectOptions deleteProjectOptions = new DeleteProjectOptions.Builder()\n", " .id(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteProject(deleteProjectOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " id: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteProject(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_project(\n", " id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a single project.", "operationId": "get_project", "responses": { "200": { "content": { "application/json": { "example": { "account_id": "f9f1030ebf674eda8d57bdbc2b9e536a", "created_at": "2021-03-29T12:18:13.992359829Z", "crn": "crn:v1:bluemix:public:codeengine:us-east:a/4329073d16d2f3663f74bfa955259139:15314cc3-85b4-4338-903f-c28cdee6d005::", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005", "id": "15314cc3-85b4-4338-903f-c28cdee6d005", "name": "test_project", "region": "us-east", "resource_group_id": "b91e849cedb04e7e92bd68c040c672dc", "resource_type": "project_v2", "status": "active" }, "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a project", "tags": [ "Projects" ], "x-ibm-permissions": { "actions": [ { "name": "resource-controller.instance.retrieve" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getProjectOptions := codeEngineService.NewGetProjectOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", ")\n", "\n", "project, response, err := codeEngineService.GetProject(getProjectOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(project, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetProjectOptions getProjectOptions = new GetProjectOptions.Builder()\n", " .id(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .build();\n", "\n", "Response response = codeEngineService.getProject(getProjectOptions).execute();\n", "Project project = response.getResult();\n", "\n", "System.out.println(project);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " id: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getProject(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_project(\n", " id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", ")\n", "project = response.get_result()\n", "\n", "print(json.dumps(project, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ] }, "/projects/{project_id}/allowed_outbound_destinations": { "get": { "description": "List all allowed outbound destinations in a project.", "operationId": "list_allowed_outbound_destinations", "parameters": [ { "description": "Optional maximum number of allowed outbound destinations per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "allowed_outbound_destinations": [ { "cidr_block": "192.168.3.0/24", "entity_tag": "2385407409", "name": "my-cidr-block", "status": "ready", "type": "cidr_block" } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/AllowedOutboundDestinationList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List allowed outbound destinations", "tags": [ "Projects" ], "x-ibm-events": { "events": [ { "name": "codeengine.allowedoutbounddestination.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/allowed_outbound_destinations?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listAllowedOutboundDestinationsOptions := &codeenginev2.ListAllowedOutboundDestinationsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewAllowedOutboundDestinationsPager(listAllowedOutboundDestinationsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.AllowedOutboundDestinationIntf\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListAllowedOutboundDestinationsOptions listAllowedOutboundDestinationsOptions = new ListAllowedOutboundDestinationsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "AllowedOutboundDestinationsPager pager = new AllowedOutboundDestinationsPager(codeEngineService, listAllowedOutboundDestinationsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.AllowedOutboundDestinationsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = AllowedOutboundDestinationsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ], "post": { "description": "Create an allowed outbound destination.", "operationId": "create_allowed_outbound_destination", "parameters": [ { "$ref": "#/components/parameters/version" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedOutboundDestinationPrototype" } } }, "description": "AllowedOutboundDestination prototype", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "cidr_block": "192.168.3.0/24", "entity_tag": "2385407409", "name": "my-cidr-block", "status": "ready", "type": "cidr_block" }, "schema": { "$ref": "#/components/schemas/AllowedOutboundDestination" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the allowed outbound destination", "schema": { "description": "version of the allowed outbound destination", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create an allowed outbound destination", "tags": [ "Projects" ], "x-codegen-request-body-name": "allowed_outbound_destination", "x-ibm-events": { "events": [ { "name": "codeengine.allowedoutbounddestination.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/allowed_outbound_destinations?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"my-cidr-block\",\n \"type\": \"cidr_block\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "allowedOutboundDestinationPrototypeModel := &codeenginev2.AllowedOutboundDestinationPrototypeCidrBlockDataPrototype{\n", " Name: core.StringPtr(\"allow-all\"),\n", " Type: core.StringPtr(\"cidr_block\"),\n", " CidrBlock: core.StringPtr(\"testString\"),\n", "}\n", "\n", "createAllowedOutboundDestinationOptions := codeEngineService.NewCreateAllowedOutboundDestinationOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " allowedOutboundDestinationPrototypeModel,\n", ")\n", "\n", "allowedOutboundDestination, response, err := codeEngineService.CreateAllowedOutboundDestination(createAllowedOutboundDestinationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(allowedOutboundDestination, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "AllowedOutboundDestinationPrototypeCidrBlockDataPrototype allowedOutboundDestinationPrototypeModel = new AllowedOutboundDestinationPrototypeCidrBlockDataPrototype.Builder()\n", " .name(\"allow-all\")\n", " .type(\"cidr_block\")\n", " .cidrBlock(\"testString\")\n", " .build();\n", "CreateAllowedOutboundDestinationOptions createAllowedOutboundDestinationOptions = new CreateAllowedOutboundDestinationOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .allowedOutboundDestination(allowedOutboundDestinationPrototypeModel)\n", " .build();\n", "\n", "Response response = codeEngineService.createAllowedOutboundDestination(createAllowedOutboundDestinationOptions).execute();\n", "AllowedOutboundDestination allowedOutboundDestination = response.getResult();\n", "\n", "System.out.println(allowedOutboundDestination);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "// Request models needed by this operation.\n", "\n", "// AllowedOutboundDestinationPrototypeCidrBlockDataPrototype\n", "const allowedOutboundDestinationPrototypeModel = {\n", " name: 'allow-all',\n", " type: 'cidr_block',\n", " cidr_block: 'testString',\n", "};\n", "\n", "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " allowedOutboundDestination: allowedOutboundDestinationPrototypeModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createAllowedOutboundDestination(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "allowed_outbound_destination_prototype_model = {\n", " 'name': 'allow-all',\n", " 'type': 'cidr_block',\n", " 'cidr_block': 'testString',\n", "}\n", "\n", "response = code_engine_service.create_allowed_outbound_destination(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " allowed_outbound_destination=allowed_outbound_destination_prototype_model,\n", ")\n", "allowed_outbound_destination = response.get_result()\n", "\n", "print(json.dumps(allowed_outbound_destination, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } }, "x-terraform-polling-delay": 30, "x-terraform-polling-failure": [ "failed" ], "x-terraform-polling-operation": "get_allowed_outbound_destination", "x-terraform-polling-pending": [ "deploying" ], "x-terraform-polling-property": "status", "x-terraform-polling-success": [ "ready" ], "x-terraform-polling-timeout": 1800 } }, "/projects/{project_id}/allowed_outbound_destinations/{name}": { "delete": { "description": "Delete an allowed outbound destination.", "operationId": "delete_allowed_outbound_destination", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete an allowed outbound destination", "tags": [ "Projects" ], "x-ibm-events": { "events": [ { "name": "codeengine.allowedoutbounddestination.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/allowed_outbound_destinations/my-allowed-outbound-destination?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteAllowedOutboundDestinationOptions := codeEngineService.NewDeleteAllowedOutboundDestinationOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-allowed-outbound-destination\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteAllowedOutboundDestination(deleteAllowedOutboundDestinationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteAllowedOutboundDestination(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteAllowedOutboundDestinationOptions deleteAllowedOutboundDestinationOptions = new DeleteAllowedOutboundDestinationOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-allowed-outbound-destination\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteAllowedOutboundDestination(deleteAllowedOutboundDestinationOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-allowed-outbound-destination',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteAllowedOutboundDestination(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_allowed_outbound_destination(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-allowed-outbound-destination',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of an allowed outbound destination.", "operationId": "get_allowed_outbound_destination", "responses": { "200": { "content": { "application/json": { "example": { "cidr_block": "192.168.3.0/24", "entity_tag": "2385407409", "name": "my-cidr-block", "status": "ready", "type": "cidr_block" }, "schema": { "$ref": "#/components/schemas/AllowedOutboundDestination" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the allowed outbound destination", "schema": { "description": "version of the allowed outbound destination", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get an allowed outbound destination", "tags": [ "Projects" ], "x-ibm-events": { "events": [ { "name": "codeengine.allowedoutbounddestination.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/allowed_outbound_destinations/my-allowed-outbound-destination?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getAllowedOutboundDestinationOptions := codeEngineService.NewGetAllowedOutboundDestinationOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-allowed-outbound-destination\",\n", ")\n", "\n", "allowedOutboundDestination, response, err := codeEngineService.GetAllowedOutboundDestination(getAllowedOutboundDestinationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(allowedOutboundDestination, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetAllowedOutboundDestinationOptions getAllowedOutboundDestinationOptions = new GetAllowedOutboundDestinationOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-allowed-outbound-destination\")\n", " .build();\n", "\n", "Response response = codeEngineService.getAllowedOutboundDestination(getAllowedOutboundDestinationOptions).execute();\n", "AllowedOutboundDestination allowedOutboundDestination = response.getResult();\n", "\n", "System.out.println(allowedOutboundDestination);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-allowed-outbound-destination',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getAllowedOutboundDestination(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_allowed_outbound_destination(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-allowed-outbound-destination',\n", ")\n", "allowed_outbound_destination = response.get_result()\n", "\n", "print(json.dumps(allowed_outbound_destination, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your allowed outbound destination.", "example": "my-allowed-outbound-destination", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "patch": { "description": "Update an allowed outbound destination.", "operationId": "update_allowed_outbound_destination", "parameters": [ { "description": "Version of the allowed outbound destination to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the allowed outbound destination. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/AllowedOutboundDestinationPatch" } } }, "description": "AllowedOutboundDestination patch", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "cidr_block": "192.168.3.0/24", "entity_tag": "2385407409", "name": "my-cidr-block", "status": "ready", "type": "cidr_block" }, "schema": { "$ref": "#/components/schemas/AllowedOutboundDestination" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the allowed outbound destination", "schema": { "description": "version of the allowed outbound destination", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update an allowed outbound destination", "tags": [ "Projects" ], "x-codegen-request-body-name": "allowed_outbound_destination", "x-ibm-events": { "events": [ { "name": "codeengine.allowedoutbounddestination.read" }, { "name": "codeengine.allowedoutbounddestination.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PATCH\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/allowed_outbound_destinations/my-allowed-outbound-destination?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --header \"If-Match: *\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "allowedOutboundDestinationPatchModel := &codeenginev2.AllowedOutboundDestinationPatchCidrBlockDataPatch{}\n", "allowedOutboundDestinationPatchModelAsPatch, asPatchErr := allowedOutboundDestinationPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateAllowedOutboundDestinationOptions := codeEngineService.NewUpdateAllowedOutboundDestinationOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-allowed-outbound-destination\",\n", " \"testString\",\n", " allowedOutboundDestinationPatchModelAsPatch,\n", ")\n", "\n", "allowedOutboundDestination, response, err := codeEngineService.UpdateAllowedOutboundDestination(updateAllowedOutboundDestinationOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(allowedOutboundDestination, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "AllowedOutboundDestinationPatchCidrBlockDataPatch allowedOutboundDestinationPatchModel = new AllowedOutboundDestinationPatchCidrBlockDataPatch.Builder()\n", " .build();\n", "Map allowedOutboundDestinationPatchModelAsPatch = allowedOutboundDestinationPatchModel.asPatch();\n", "UpdateAllowedOutboundDestinationOptions updateAllowedOutboundDestinationOptions = new UpdateAllowedOutboundDestinationOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-allowed-outbound-destination\")\n", " .ifMatch(\"testString\")\n", " .allowedOutboundDestination(allowedOutboundDestinationPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = codeEngineService.updateAllowedOutboundDestination(updateAllowedOutboundDestinationOptions).execute();\n", "AllowedOutboundDestination allowedOutboundDestination = response.getResult();\n", "\n", "System.out.println(allowedOutboundDestination);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "// Request models needed by this operation.\n", "\n", "// AllowedOutboundDestinationPatchCidrBlockDataPatch\n", "const allowedOutboundDestinationPatchModel = {};\n", "\n", "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-allowed-outbound-destination',\n", " ifMatch: 'testString',\n", " allowedOutboundDestination: allowedOutboundDestinationPatchModel,\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.updateAllowedOutboundDestination(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "allowed_outbound_destination_patch_model = {}\n", "\n", "response = code_engine_service.update_allowed_outbound_destination(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-allowed-outbound-destination',\n", " if_match='testString',\n", " allowed_outbound_destination=allowed_outbound_destination_patch_model,\n", ")\n", "allowed_outbound_destination = response.get_result()\n", "\n", "print(json.dumps(allowed_outbound_destination, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/apps": { "get": { "description": "List all applications in a project.", "operationId": "list_apps", "parameters": [ { "description": "Optional maximum number of apps per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "apps": [ { "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "endpoint_internal": "http://my-app.uyh5shf7s0f.svc.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app", "id": "230828b4-4f15-40a9-b183-1268c6ab88d5", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "managed_domain_mappings": "local_public", "name": "my-app", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/AppList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List applications", "tags": [ "Applications" ], "x-ibm-events": { "events": [ { "name": "codeengine.application.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listAppsOptions := &codeenginev2.ListAppsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewAppsPager(listAppsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.App\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListAppsOptions listAppsOptions = new ListAppsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "AppsPager pager = new AppsPager(codeEngineService, listAppsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.AppsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = AppsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create an application.", "operationId": "create_app", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppPrototype" } } }, "description": "App prototype", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "endpoint_internal": "http://my-app.uyh5shf7s0f.svc.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "managed_domain_mappings": "local_public", "name": "my-app", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_down_delay": 0, "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" }, "schema": { "$ref": "#/components/schemas/App" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the app", "schema": { "description": "version of the app", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create an application", "tags": [ "Applications" ], "x-codegen-request-body-name": "app", "x-ibm-events": { "events": [ { "name": "codeengine.application.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"my-app\",\n \"image_reference\": \"icr.io/codeengine/helloworld\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createAppOptions := codeEngineService.NewCreateAppOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"icr.io/codeengine/helloworld\",\n", " \"my-app\",\n", ")\n", "\n", "app, response, err := codeEngineService.CreateApp(createAppOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(app, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateAppOptions createAppOptions = new CreateAppOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .imageReference(\"icr.io/codeengine/helloworld\")\n", " .name(\"my-app\")\n", " .build();\n", "\n", "Response response = codeEngineService.createApp(createAppOptions).execute();\n", "App app = response.getResult();\n", "\n", "System.out.println(app);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " imageReference: 'icr.io/codeengine/helloworld',\n", " name: 'my-app',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createApp(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_app(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " image_reference='icr.io/codeengine/helloworld',\n", " name='my-app',\n", ")\n", "app = response.get_result()\n", "\n", "print(json.dumps(app, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } }, "x-terraform-polling-delay": 20, "x-terraform-polling-operation": "get_app", "x-terraform-polling-pending": [ "deploying" ], "x-terraform-polling-property": "status", "x-terraform-polling-success": [ "ready", "failed", "warning" ], "x-terraform-polling-timeout": 600 } }, "/projects/{project_id}/apps/{app_name}/instances": { "get": { "description": "List all instances of an application.", "operationId": "list_app_instances", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your application.", "example": "my-app", "in": "path", "name": "app_name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "description": "Optional maximum number of apps per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "responses": { "200": { "content": { "application/json": { "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/instances?limit=50" }, "instances": [ { "app_name": "crash", "created_at": "2023-10-23T11:56:46-04:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/instances", "id": "7755a00a-0d8f-4eab-8dbd-ab43fc3498dd", "name": "crash-00001-deployment-86c64f66fd-cjwqp", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_instance_v2", "revision_name": "crash-00001", "scale_cpu_limit": "0.125", "scale_ephemeral_storage_limit": "400M", "scale_memory_limit": "250M", "status": "running", "status_details": { "restarts": 58, "system_containers": { "current_state": { "container_status": "running", "start_time": "2023-10-23T11:57:10-04:00" }, "last_observed_state": {} }, "user_container": { "current_state": { "completed_at": "2023-10-23T16:56:02-04:00", "container_status": "terminated", "exit_code": 1, "reason": "OOMKilled", "started_at": "2023-10-23T16:55:36-04:00" }, "last_observed_state": { "completed_at": "2023-10-23T16:50:24-04:00", "container_status": "terminated", "exit_code": 1, "reason": "OOMKilled", "started_at": "2023-10-23T16:49:58-04:00" } } } } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/AppInstanceList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List application instances", "tags": [ "Applications" ], "x-ibm-events": { "events": [ { "name": "codeengine.application.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/instances?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listAppInstancesOptions := &codeenginev2.ListAppInstancesOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " AppName: core.StringPtr(\"my-app\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewAppInstancesPager(listAppInstancesOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.AppInstance\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListAppInstancesOptions listAppInstancesOptions = new ListAppInstancesOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .appName(\"my-app\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "AppInstancesPager pager = new AppInstancesPager(codeEngineService, listAppInstancesOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " appName: 'my-app',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.AppInstancesPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = AppInstancesPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " app_name='my-app',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/apps/{app_name}/revisions": { "get": { "description": "List all application revisions in a particular application.", "operationId": "list_app_revisions", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your application.", "example": "my-app", "in": "path", "name": "app_name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "description": "Optional maximum number of apps per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "responses": { "200": { "content": { "application/json": { "example": { "limit": 50, "revisions": [ { "app_name": "my-app", "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/revisions/my-app-00001", "id": "b63b3e28-2c1b-4784-9cd6-18c201fc6806", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "name": "my-app-00001", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_revision_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" } ] }, "schema": { "$ref": "#/components/schemas/AppRevisionList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List application revisions", "tags": [ "Applications" ], "x-ibm-events": { "events": [ { "name": "codeengine.application.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/revisions?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listAppRevisionsOptions := &codeenginev2.ListAppRevisionsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " AppName: core.StringPtr(\"my-app\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewAppRevisionsPager(listAppRevisionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.AppRevision\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListAppRevisionsOptions listAppRevisionsOptions = new ListAppRevisionsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .appName(\"my-app\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "AppRevisionsPager pager = new AppRevisionsPager(codeEngineService, listAppRevisionsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " appName: 'my-app',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.AppRevisionsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = AppRevisionsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " app_name='my-app',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/apps/{app_name}/revisions/{name}": { "delete": { "description": "Delete an application revision.", "operationId": "delete_app_revision", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete an application revision", "tags": [ "Applications" ], "x-ibm-events": { "events": [ { "name": "codeengine.application.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/revisions/my-app-00001?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteAppRevisionOptions := codeEngineService.NewDeleteAppRevisionOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-app\",\n", " \"my-app-00001\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteAppRevision(deleteAppRevisionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteAppRevision(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteAppRevisionOptions deleteAppRevisionOptions = new DeleteAppRevisionOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .appName(\"my-app\")\n", " .name(\"my-app-00001\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteAppRevision(deleteAppRevisionOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " appName: 'my-app',\n", " name: 'my-app-00001',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteAppRevision(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_app_revision(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " app_name='my-app',\n", " name='my-app-00001',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of an application revision.", "operationId": "get_app_revision", "responses": { "200": { "content": { "application/json": { "example": { "app_name": "my-app", "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/revisions/my-app-00001", "id": "b63b3e28-2c1b-4784-9cd6-18c201fc6806", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "name": "my-app-00001", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_revision_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" }, "schema": { "$ref": "#/components/schemas/AppRevision" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get an application revision", "tags": [ "Applications" ], "x-ibm-events": { "events": [ { "name": "codeengine.application.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app/revisions/my-app-00001?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getAppRevisionOptions := codeEngineService.NewGetAppRevisionOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-app\",\n", " \"my-app-00001\",\n", ")\n", "\n", "appRevision, response, err := codeEngineService.GetAppRevision(getAppRevisionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(appRevision, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetAppRevisionOptions getAppRevisionOptions = new GetAppRevisionOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .appName(\"my-app\")\n", " .name(\"my-app-00001\")\n", " .build();\n", "\n", "Response response = codeEngineService.getAppRevision(getAppRevisionOptions).execute();\n", "AppRevision appRevision = response.getResult();\n", "\n", "System.out.println(appRevision);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " appName: 'my-app',\n", " name: 'my-app-00001',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getAppRevision(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_app_revision(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " app_name='my-app',\n", " name='my-app-00001',\n", ")\n", "app_revision = response.get_result()\n", "\n", "print(json.dumps(app_revision, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your application.", "example": "my-app", "in": "path", "name": "app_name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "description": "The name of your application revision.", "example": "my-app-00001", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ] }, "/projects/{project_id}/apps/{name}": { "delete": { "description": "Delete an application.", "operationId": "delete_app", "parameters": [ { "description": "Determines if connected service access secrets remain intact after app deletion.", "in": "query", "name": "keep_service_access", "schema": { "default": false, "type": "boolean" } } ], "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete an application", "tags": [ "Applications" ], "x-ibm-events": { "events": [ { "name": "codeengine.application.read" }, { "name": "codeengine.application.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteAppOptions := codeEngineService.NewDeleteAppOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-app\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteApp(deleteAppOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteApp(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteAppOptions deleteAppOptions = new DeleteAppOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-app\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteApp(deleteAppOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-app',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteApp(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_app(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-app',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of an application.", "operationId": "get_app", "responses": { "200": { "content": { "application/json": { "example": { "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "endpoint_internal": "http://my-app.uyh5shf7s0f.svc.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "managed_domain_mappings": "local_public", "name": "my-app", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_down_delay": 0, "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" }, "schema": { "$ref": "#/components/schemas/App" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the app", "schema": { "description": "version of the app", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get an application", "tags": [ "Applications" ], "x-ibm-events": { "events": [ { "name": "codeengine.application.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getAppOptions := codeEngineService.NewGetAppOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-app\",\n", ")\n", "\n", "app, response, err := codeEngineService.GetApp(getAppOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(app, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetAppOptions getAppOptions = new GetAppOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-app\")\n", " .build();\n", "\n", "Response response = codeEngineService.getApp(getAppOptions).execute();\n", "App app = response.getResult();\n", "\n", "System.out.println(app);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-app',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getApp(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_app(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-app',\n", ")\n", "app = response.get_result()\n", "\n", "print(json.dumps(app, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your application.", "example": "my-app", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "patch": { "description": "An application contains one or more revisions. A revision represents an immutable version of the configuration properties of the application. Each update of an application configuration property creates a new revision of the application. [Learn more](https://cloud.ibm.com/docs/codeengine?topic=codeengine-update-app)", "operationId": "update_app", "parameters": [ { "description": "Version of the app settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the app. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/AppPatch" } } }, "description": "App patch", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "computed_env_variables": [ { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_APP", "type": "literal", "value": "my-app" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" } ], "created_at": "2022-11-15T22:07:55+01:00", "endpoint_internal": "http://my-app.uyh5shf7s0f.svc.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "image_port": 8080, "image_reference": "icr.io/codeengine/helloworld", "managed_domain_mappings": "local_public", "name": "my-app", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "app_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_service_account": "default", "run_volume_mounts": [], "scale_concurrency": 100, "scale_cpu_limit": "1", "scale_down_delay": 0, "scale_ephemeral_storage_limit": "400M", "scale_initial_instances": 1, "scale_max_instances": 10, "scale_memory_limit": "4G", "scale_min_instances": 0, "scale_request_timeout": 300, "status": "ready" }, "schema": { "$ref": "#/components/schemas/App" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the app", "schema": { "description": "version of the app", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update an application", "tags": [ "Applications" ], "x-codegen-request-body-name": "app", "x-ibm-events": { "events": [ { "name": "codeengine.application.read" }, { "name": "codeengine.application.list" }, { "name": "codeengine.application.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PATCH\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/apps/my-app?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --header \"If-Match: *\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "appPatchModel := &codeenginev2.AppPatch{}\n", "appPatchModelAsPatch, asPatchErr := appPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateAppOptions := codeEngineService.NewUpdateAppOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-app\",\n", " \"testString\",\n", " appPatchModelAsPatch,\n", ")\n", "\n", "app, response, err := codeEngineService.UpdateApp(updateAppOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(app, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "AppPatch appPatchModel = new AppPatch.Builder()\n", " .build();\n", "Map appPatchModelAsPatch = appPatchModel.asPatch();\n", "UpdateAppOptions updateAppOptions = new UpdateAppOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-app\")\n", " .ifMatch(\"testString\")\n", " .app(appPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = codeEngineService.updateApp(updateAppOptions).execute();\n", "App app = response.getResult();\n", "\n", "System.out.println(app);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-app',\n", " ifMatch: 'testString',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.updateApp(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "app_patch_model = {}\n", "\n", "response = code_engine_service.update_app(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-app',\n", " if_match='testString',\n", " app=app_patch_model,\n", ")\n", "app = response.get_result()\n", "\n", "print(json.dumps(app, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/bindings": { "get": { "description": "List all bindings in a project.", "operationId": "list_bindings", "parameters": [ { "description": "Optional maximum number of bindings per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bindings": [ { "component": { "name": "my-app-1", "resource_type": "app_v2" }, "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings/app_my-app-1_my-service-access_PREFIX", "id": "app_my-app-1_my-service-access_PREFIX", "prefix": "PREFIX", "project_id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "region": "us-east", "resource_type": "binding_v2", "secret_name": "my-service-access", "status": "active" } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/BindingList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List bindings", "tags": [ "Service bindings" ], "x-ibm-events": { "events": [ { "name": "codeengine.secret.list" }, { "name": "codeengine.application.list" }, { "name": "codeengine.job.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listBindingsOptions := &codeenginev2.ListBindingsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewBindingsPager(listBindingsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.Binding\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListBindingsOptions listBindingsOptions = new ListBindingsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "BindingsPager pager = new BindingsPager(codeEngineService, listBindingsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.BindingsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = BindingsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a binding. Creating a service binding with a Code Engine app will update the app, creating a new revision. For more information see the [documentation](https://cloud.ibm.com/docs/codeengine?topic=codeengine-service-binding)", "operationId": "create_binding", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BindingPrototype" } } }, "description": "Binding prototype.", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "component": { "name": "my-app-1", "resource_type": "app_v2" }, "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings/a172ced-b5f21bc-71ba50c-1638604", "id": "a172ced-b5f21bc-71ba50c-1638604", "prefix": "PREFIX", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "resource_type": "binding_v2", "secret_name": "my-service-access", "status": "active" }, "schema": { "$ref": "#/components/schemas/Binding" } } }, "description": "Created" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a binding", "tags": [ "Service bindings" ], "x-codegen-request-body-name": "binding", "x-ibm-events": { "events": [ { "name": "codeengine.secret.create" }, { "name": "codeengine.secret.read" }, { "name": "codeengine.secret.update" }, { "name": "codeengine.application.list" }, { "name": "codeengine.application.update" }, { "name": "codeengine.job.list" }, { "name": "codeengine.job.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" }, { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"component\": {\n \"name\": \"my-app-1\",\n \"resource_type\": \"app_v2\"\n },\n \"prefix\": \"PREFIX\",\n \"secret_name\": \"my-service-access\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "componentRefModel := &codeenginev2.ComponentRef{\n", " Name: core.StringPtr(\"my-app-1\"),\n", " ResourceType: core.StringPtr(\"app_v2\"),\n", "}\n", "\n", "createBindingOptions := codeEngineService.NewCreateBindingOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " componentRefModel,\n", " \"MY_COS\",\n", " \"my-service-access\",\n", ")\n", "\n", "binding, response, err := codeEngineService.CreateBinding(createBindingOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(binding, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ComponentRef componentRefModel = new ComponentRef.Builder()\n", " .name(\"my-app-1\")\n", " .resourceType(\"app_v2\")\n", " .build();\n", "CreateBindingOptions createBindingOptions = new CreateBindingOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .component(componentRefModel)\n", " .prefix(\"MY_COS\")\n", " .secretName(\"my-service-access\")\n", " .build();\n", "\n", "Response response = codeEngineService.createBinding(createBindingOptions).execute();\n", "Binding binding = response.getResult();\n", "\n", "System.out.println(binding);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "// Request models needed by this operation.\n", "\n", "// ComponentRef\n", "const componentRefModel = {\n", " name: 'my-app-1',\n", " resource_type: 'app_v2',\n", "};\n", "\n", "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " component: componentRefModel,\n", " prefix: 'MY_COS',\n", " secretName: 'my-service-access',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createBinding(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "component_ref_model = {\n", " 'name': 'my-app-1',\n", " 'resource_type': 'app_v2',\n", "}\n", "\n", "response = code_engine_service.create_binding(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " component=component_ref_model,\n", " prefix='MY_COS',\n", " secret_name='my-service-access',\n", ")\n", "binding = response.get_result()\n", "\n", "print(json.dumps(binding, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/bindings/{id}": { "delete": { "description": "Delete a binding.", "operationId": "delete_binding", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a binding", "tags": [ "Service bindings" ], "x-ibm-events": { "events": [ { "name": "codeengine.secret.list" }, { "name": "codeengine.secret.update" }, { "name": "codeengine.application.list" }, { "name": "codeengine.application.update" }, { "name": "codeengine.job.list" }, { "name": "codeengine.job.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" }, { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings/a172ced-b5f21bc-71ba50c-1638604?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteBindingOptions := codeEngineService.NewDeleteBindingOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"a172ced-b5f21bc-71ba50c-1638604\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteBinding(deleteBindingOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteBinding(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteBindingOptions deleteBindingOptions = new DeleteBindingOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .id(\"a172ced-b5f21bc-71ba50c-1638604\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteBinding(deleteBindingOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " id: 'a172ced-b5f21bc-71ba50c-1638604',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteBinding(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_binding(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " id='a172ced-b5f21bc-71ba50c-1638604',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a binding.", "operationId": "get_binding", "responses": { "200": { "content": { "application/json": { "example": { "component": { "name": "my-app-1", "resource_type": "app_v2" }, "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings/a172ced-b5f21bc-71ba50c-1638604", "id": "a172ced-b5f21bc-71ba50c-1638604", "prefix": "PREFIX", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "resource_type": "binding_v2", "secret_name": "my-service-access", "status": "active" }, "schema": { "$ref": "#/components/schemas/Binding" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a binding", "tags": [ "Service bindings" ], "x-ibm-events": { "events": [ { "name": "codeengine.secret.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/bindings/a172ced-b5f21bc-71ba50c-1638604?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getBindingOptions := codeEngineService.NewGetBindingOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"a172ced-b5f21bc-71ba50c-1638604\",\n", ")\n", "\n", "binding, response, err := codeEngineService.GetBinding(getBindingOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(binding, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetBindingOptions getBindingOptions = new GetBindingOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .id(\"a172ced-b5f21bc-71ba50c-1638604\")\n", " .build();\n", "\n", "Response response = codeEngineService.getBinding(getBindingOptions).execute();\n", "Binding binding = response.getResult();\n", "\n", "System.out.println(binding);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " id: 'a172ced-b5f21bc-71ba50c-1638604',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getBinding(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_binding(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " id='a172ced-b5f21bc-71ba50c-1638604',\n", ")\n", "binding = response.get_result()\n", "\n", "print(json.dumps(binding, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the binding.", "example": "a172ced-b5f21bc-71ba50c-1638604", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 253, "minLength": 1, "pattern": "^.+$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ] }, "/projects/{project_id}/build_runs": { "get": { "description": "List all build runs in a project.", "operationId": "list_build_runs", "parameters": [ { "description": "Optional name of the build that should be filtered for.", "example": "my-build", "in": "query", "name": "build_name", "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "description": "Optional maximum number of build runs per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "build_runs": [ { "build_name": "my-build", "created_at": "2022-06-20T10:10:00+02:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs/my-buildrun-1", "id": "ca151bf7-b1bf-4e18-a1cb-857329c2d097", "name": "my-buildrun-1", "project_id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "region": "us-east", "resource_type": "build_run_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "service_account": "default", "source_type": "git", "status": "succeeded", "strategy_size": "large", "strategy_type": "dockerfile" } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/BuildRunList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List build runs", "tags": [ "Image builds" ], "x-ibm-events": { "events": [ { "name": "codeengine.buildrun.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listBuildRunsOptions := &codeenginev2.ListBuildRunsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " BuildName: core.StringPtr(\"my-build\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewBuildRunsPager(listBuildRunsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.BuildRun\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListBuildRunsOptions listBuildRunsOptions = new ListBuildRunsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .buildName(\"my-build\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "BuildRunsPager pager = new BuildRunsPager(codeEngineService, listBuildRunsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " buildName: 'my-build',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.BuildRunsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = BuildRunsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " build_name='my-build',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a build run.", "operationId": "create_build_run", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildRunPrototype" } } }, "description": "Build run prototype", "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "build_name": "my-build", "created_at": "2022-06-20T10:10:00+02:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs/my-buildrun-1", "id": "ca151bf7-b1bf-4e18-a1cb-857329c2d097", "name": "my-buildrun-1", "project_id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "region": "us-east", "resource_type": "build_run_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "service_account": "default", "source_type": "git", "status": "succeeded", "strategy_size": "large", "strategy_type": "dockerfile" }, "schema": { "$ref": "#/components/schemas/BuildRun" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a build run", "tags": [ "Image builds" ], "x-codegen-request-body-name": "buildrun", "x-ibm-events": { "events": [ { "name": "codeengine.buildrun.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createBuildRunOptions := codeEngineService.NewCreateBuildRunOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", ")\n", "\n", "buildRun, response, err := codeEngineService.CreateBuildRun(createBuildRunOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(buildRun, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateBuildRunOptions createBuildRunOptions = new CreateBuildRunOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .build();\n", "\n", "Response response = codeEngineService.createBuildRun(createBuildRunOptions).execute();\n", "BuildRun buildRun = response.getResult();\n", "\n", "System.out.println(buildRun);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createBuildRun(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_build_run(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", ")\n", "build_run = response.get_result()\n", "\n", "print(json.dumps(build_run, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/build_runs/{name}": { "delete": { "description": "Delete a build run.", "operationId": "delete_build_run", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a build run", "tags": [ "Image builds" ], "x-ibm-events": { "events": [ { "name": "codeengine.buildrun.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs/my-build-run?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteBuildRunOptions := codeEngineService.NewDeleteBuildRunOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-build-run\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteBuildRun(deleteBuildRunOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteBuildRun(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteBuildRunOptions deleteBuildRunOptions = new DeleteBuildRunOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-build-run\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteBuildRun(deleteBuildRunOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-build-run',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteBuildRun(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_build_run(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-build-run',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a build run.", "operationId": "get_build_run", "responses": { "200": { "content": { "application/json": { "example": { "build_name": "my-build", "created_at": "2022-06-20T10:10:00+02:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs/my-buildrun-1", "id": "ca151bf7-b1bf-4e18-a1cb-857329c2d097", "name": "my-buildrun-1", "project_id": "4e49b3e0-27a8-48d2-a784-c7ee48bb863b", "region": "us-east", "resource_type": "build_run_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "service_account": "default", "source_type": "git", "status": "succeeded", "strategy_size": "large", "strategy_type": "dockerfile" }, "schema": { "$ref": "#/components/schemas/BuildRun" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a build run", "tags": [ "Image builds" ], "x-ibm-events": { "events": [ { "name": "codeengine.buildrun.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/build_runs/my-build-run?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getBuildRunOptions := codeEngineService.NewGetBuildRunOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-build-run\",\n", ")\n", "\n", "buildRun, response, err := codeEngineService.GetBuildRun(getBuildRunOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(buildRun, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetBuildRunOptions getBuildRunOptions = new GetBuildRunOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-build-run\")\n", " .build();\n", "\n", "Response response = codeEngineService.getBuildRun(getBuildRunOptions).execute();\n", "BuildRun buildRun = response.getResult();\n", "\n", "System.out.println(buildRun);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-build-run',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getBuildRun(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_build_run(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-build-run',\n", ")\n", "build_run = response.get_result()\n", "\n", "print(json.dumps(build_run, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your build run.", "example": "my-build-run", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ] }, "/projects/{project_id}/builds": { "get": { "description": "List all builds in a project.", "operationId": "list_builds", "parameters": [ { "description": "Optional maximum number of builds per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "builds": [ { "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "my-build", "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "build_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "status": "ready", "strategy_size": "medium", "strategy_type": "dockerfile", "timeout": 600 } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/BuildList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List builds", "tags": [ "Image builds" ], "x-ibm-events": { "events": [ { "name": "codeengine.build.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listBuildsOptions := &codeenginev2.ListBuildsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewBuildsPager(listBuildsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.Build\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListBuildsOptions listBuildsOptions = new ListBuildsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "BuildsPager pager = new BuildsPager(codeEngineService, listBuildsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.BuildsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = BuildsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a build.", "operationId": "create_build", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildPrototype" } } }, "description": "Build prototype", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "my-build", "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "build_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "status": "ready", "strategy_size": "medium", "strategy_type": "dockerfile", "timeout": 600 }, "schema": { "$ref": "#/components/schemas/Build" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the build", "schema": { "description": "version of the build", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a build", "tags": [ "Image builds" ], "x-codegen-request-body-name": "build", "x-ibm-events": { "events": [ { "name": "codeengine.build.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"my-build\",\n \"output_image\": \"private.de.icr.io/icr_namespace/test-image-1\",\n \"output_secret\": \"ce-auto-icr-private-eu-de\",\n \"strategy_type\": \"dockerfile\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createBuildOptions := codeEngineService.NewCreateBuildOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-build\",\n", " \"private.de.icr.io/icr_namespace/image-name\",\n", " \"ce-auto-icr-private-eu-de\",\n", " \"dockerfile\",\n", ")\n", "\n", "build, response, err := codeEngineService.CreateBuild(createBuildOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(build, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateBuildOptions createBuildOptions = new CreateBuildOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-build\")\n", " .outputImage(\"private.de.icr.io/icr_namespace/image-name\")\n", " .outputSecret(\"ce-auto-icr-private-eu-de\")\n", " .strategyType(\"dockerfile\")\n", " .build();\n", "\n", "Response response = codeEngineService.createBuild(createBuildOptions).execute();\n", "Build build = response.getResult();\n", "\n", "System.out.println(build);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-build',\n", " outputImage: 'private.de.icr.io/icr_namespace/image-name',\n", " outputSecret: 'ce-auto-icr-private-eu-de',\n", " strategyType: 'dockerfile',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createBuild(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_build(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-build',\n", " output_image='private.de.icr.io/icr_namespace/image-name',\n", " output_secret='ce-auto-icr-private-eu-de',\n", " strategy_type='dockerfile',\n", ")\n", "build = response.get_result()\n", "\n", "print(json.dumps(build, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/builds/{name}": { "delete": { "description": "Delete a build.", "operationId": "delete_build", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a build", "tags": [ "Image builds" ], "x-ibm-events": { "events": [ { "name": "codeengine.build.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteBuildOptions := codeEngineService.NewDeleteBuildOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-build\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteBuild(deleteBuildOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteBuild(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteBuildOptions deleteBuildOptions = new DeleteBuildOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-build\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteBuild(deleteBuildOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-build',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteBuild(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_build(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-build',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a build.", "operationId": "get_build", "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "my-build", "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "build_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "status": "ready", "strategy_size": "medium", "strategy_type": "dockerfile", "timeout": 600 }, "schema": { "$ref": "#/components/schemas/Build" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the build", "schema": { "description": "version of the build", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a build", "tags": [ "Image builds" ], "x-ibm-events": { "events": [ { "name": "codeengine.build.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getBuildOptions := codeEngineService.NewGetBuildOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-build\",\n", ")\n", "\n", "build, response, err := codeEngineService.GetBuild(getBuildOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(build, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetBuildOptions getBuildOptions = new GetBuildOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-build\")\n", " .build();\n", "\n", "Response response = codeEngineService.getBuild(getBuildOptions).execute();\n", "Build build = response.getResult();\n", "\n", "System.out.println(build);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-build',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getBuild(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_build(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-build',\n", ")\n", "build = response.get_result()\n", "\n", "print(json.dumps(build, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your build.", "example": "my-build", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "patch": { "description": "Update a build.", "operationId": "update_build", "parameters": [ { "description": "Version of the build settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the build. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/BuildPatch" } } }, "description": "Build patch", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "my-build", "output_image": "private.de.icr.io/icr_namespace/test-image-1", "output_secret": "ce-auto-icr-private-eu-de", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "build_v2", "run_build_params": [ { "name": "var-name", "type": "literal", "value": "some-value" } ], "source_revision": "main", "source_type": "git", "source_url": "https://github.com/IBM/CodeEngine", "status": "ready", "strategy_size": "medium", "strategy_type": "dockerfile", "timeout": 600 }, "schema": { "$ref": "#/components/schemas/Build" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the build", "schema": { "description": "version of the build", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update a build", "tags": [ "Image builds" ], "x-codegen-request-body-name": "build", "x-ibm-events": { "events": [ { "name": "codeengine.build.read" }, { "name": "codeengine.build.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PATCH\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/builds/my-build?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --header \"If-Match: *\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "buildPatchModel := &codeenginev2.BuildPatch{}\n", "buildPatchModelAsPatch, asPatchErr := buildPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateBuildOptions := codeEngineService.NewUpdateBuildOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-build\",\n", " \"testString\",\n", " buildPatchModelAsPatch,\n", ")\n", "\n", "build, response, err := codeEngineService.UpdateBuild(updateBuildOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(build, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "BuildPatch buildPatchModel = new BuildPatch.Builder()\n", " .build();\n", "Map buildPatchModelAsPatch = buildPatchModel.asPatch();\n", "UpdateBuildOptions updateBuildOptions = new UpdateBuildOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-build\")\n", " .ifMatch(\"testString\")\n", " .build(buildPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = codeEngineService.updateBuild(updateBuildOptions).execute();\n", "Build build = response.getResult();\n", "\n", "System.out.println(build);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-build',\n", " ifMatch: 'testString',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.updateBuild(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "build_patch_model = {}\n", "\n", "response = code_engine_service.update_build(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-build',\n", " if_match='testString',\n", " build=build_patch_model,\n", ")\n", "build = response.get_result()\n", "\n", "print(json.dumps(build, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/config_maps": { "get": { "description": "List all config maps in a project.", "operationId": "list_config_maps", "parameters": [ { "description": "Optional maximum number of config maps per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "config_maps": [ { "created_at": "2022-11-15T21:45:49+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386238209", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map", "id": "b8376985-d6df-43c5-8feb-194d45390bc8", "name": "my-config-map", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "config_map_v2" } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/ConfigMapList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List config maps", "tags": [ "Secrets and configmaps" ], "x-ibm-events": { "events": [ { "name": "codeengine.configmap.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listConfigMapsOptions := &codeenginev2.ListConfigMapsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewConfigMapsPager(listConfigMapsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.ConfigMap\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListConfigMapsOptions listConfigMapsOptions = new ListConfigMapsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "ConfigMapsPager pager = new ConfigMapsPager(codeEngineService, listConfigMapsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.ConfigMapsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = ConfigMapsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a config map.", "operationId": "create_config_map", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMapPrototype" } } }, "description": "Config map prototype.", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "created_at": "2022-11-15T21:45:49+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386238209", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map", "id": "b8376985-d6df-43c5-8feb-194d45390bc8", "name": "my-config-map", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "config_map_v2" }, "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the config map", "schema": { "description": "version of the config map", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a config map", "tags": [ "Secrets and configmaps" ], "x-codegen-request-body-name": "configmap", "x-ibm-events": { "events": [ { "name": "codeengine.configmap.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"my-config-map\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createConfigMapOptions := codeEngineService.NewCreateConfigMapOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-config-map\",\n", ")\n", "\n", "configMap, response, err := codeEngineService.CreateConfigMap(createConfigMapOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(configMap, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateConfigMapOptions createConfigMapOptions = new CreateConfigMapOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-config-map\")\n", " .build();\n", "\n", "Response response = codeEngineService.createConfigMap(createConfigMapOptions).execute();\n", "ConfigMap configMap = response.getResult();\n", "\n", "System.out.println(configMap);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-config-map',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createConfigMap(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_config_map(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-config-map',\n", ")\n", "config_map = response.get_result()\n", "\n", "print(json.dumps(config_map, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/config_maps/{name}": { "delete": { "description": "Delete a config map.", "operationId": "delete_config_map", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a config map", "tags": [ "Secrets and configmaps" ], "x-ibm-events": { "events": [ { "name": "codeengine.configmap.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteConfigMapOptions := codeEngineService.NewDeleteConfigMapOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-config-map\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteConfigMap(deleteConfigMapOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteConfigMap(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteConfigMapOptions deleteConfigMapOptions = new DeleteConfigMapOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-config-map\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteConfigMap(deleteConfigMapOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-config-map',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteConfigMap(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_config_map(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-config-map',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a config map.", "operationId": "get_config_map", "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2022-11-15T21:45:49+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386238209", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map", "id": "b8376985-d6df-43c5-8feb-194d45390bc8", "name": "my-config-map", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "config_map_v2" }, "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the config map", "schema": { "description": "version of the config map", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a config map", "tags": [ "Secrets and configmaps" ], "x-ibm-events": { "events": [ { "name": "codeengine.configmap.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getConfigMapOptions := codeEngineService.NewGetConfigMapOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-config-map\",\n", ")\n", "\n", "configMap, response, err := codeEngineService.GetConfigMap(getConfigMapOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(configMap, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetConfigMapOptions getConfigMapOptions = new GetConfigMapOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-config-map\")\n", " .build();\n", "\n", "Response response = codeEngineService.getConfigMap(getConfigMapOptions).execute();\n", "ConfigMap configMap = response.getResult();\n", "\n", "System.out.println(configMap);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-config-map',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getConfigMap(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_config_map(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-config-map',\n", ")\n", "config_map = response.get_result()\n", "\n", "print(json.dumps(config_map, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your configmap.", "example": "my-config-map", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "put": { "description": "Update a config map.", "operationId": "replace_config_map", "parameters": [ { "description": "Version of the config map settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the config map. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMapPatch" } } }, "description": "Config map prototype.", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2022-11-15T21:45:49+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386238209", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map", "id": "b8376985-d6df-43c5-8feb-194d45390bc8", "name": "my-config-map", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "config_map_v2" }, "schema": { "$ref": "#/components/schemas/ConfigMap" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the config map", "schema": { "description": "version of the config map", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update a config map", "tags": [ "Secrets and configmaps" ], "x-codegen-request-body-name": "configmap", "x-ibm-events": { "events": [ { "name": "codeengine.configmap.read" }, { "name": "codeengine.configmap.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PUT\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/config_maps/my-config-map?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "replaceConfigMapOptions := codeEngineService.NewReplaceConfigMapOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-config-map\",\n", " \"testString\",\n", ")\n", "\n", "configMap, response, err := codeEngineService.ReplaceConfigMap(replaceConfigMapOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(configMap, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ReplaceConfigMapOptions replaceConfigMapOptions = new ReplaceConfigMapOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-config-map\")\n", " .ifMatch(\"testString\")\n", " .build();\n", "\n", "Response response = codeEngineService.replaceConfigMap(replaceConfigMapOptions).execute();\n", "ConfigMap configMap = response.getResult();\n", "\n", "System.out.println(configMap);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-config-map',\n", " ifMatch: 'testString',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.replaceConfigMap(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.replace_config_map(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-config-map',\n", " if_match='testString',\n", ")\n", "config_map = response.get_result()\n", "\n", "print(json.dumps(config_map, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/domain_mappings": { "get": { "description": "List all domain mappings in a project.", "operationId": "list_domain_mappings", "parameters": [ { "description": "Optional maximum number of domain mappings per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "domain_mappings": [ { "cname_target": "custom.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "component": { "name": "my-app", "resource_type": "app_v2" }, "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "www.example.com", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "domain_mapping_v2", "status": "ready", "tls_secret": "my-tls-secret", "user_managed": true, "visibility": "custom" } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/DomainMappingList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List domain mappings", "tags": [ "Domain mappings" ], "x-ibm-events": { "events": [ { "name": "codeengine.domainmapping.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listDomainMappingsOptions := &codeenginev2.ListDomainMappingsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewDomainMappingsPager(listDomainMappingsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.DomainMapping\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListDomainMappingsOptions listDomainMappingsOptions = new ListDomainMappingsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "DomainMappingsPager pager = new DomainMappingsPager(codeEngineService, listDomainMappingsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.DomainMappingsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = DomainMappingsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a domain mapping", "operationId": "create_domain_mapping", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainMappingPrototype" } } }, "description": "DomainMapping prototype", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "cname_target": "custom.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "component": { "name": "my-app", "resource_type": "app_v2" }, "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "www.example.com", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "domain_mapping_v2", "status": "ready", "tls_secret": "my-tls-secret", "user_managed": true, "visibility": "custom" }, "schema": { "$ref": "#/components/schemas/DomainMapping" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the domain mapping", "schema": { "description": "version of the domain mapping", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a domain mapping", "tags": [ "Domain mappings" ], "x-codegen-request-body-name": "domain_mapping", "x-ibm-events": { "events": [ { "name": "codeengine.domainmapping.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"www.example.com\",\n \"component\": {\n \"name\": \"my-app\",\n \"resource_type\": \"app_v2\"\n },\n \"tls_secret\": \"my-tls-secret\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "componentRefModel := &codeenginev2.ComponentRef{\n", " Name: core.StringPtr(\"my-app-1\"),\n", " ResourceType: core.StringPtr(\"app_v2\"),\n", "}\n", "\n", "createDomainMappingOptions := codeEngineService.NewCreateDomainMappingOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " componentRefModel,\n", " \"www.example.com\",\n", " \"my-tls-secret\",\n", ")\n", "\n", "domainMapping, response, err := codeEngineService.CreateDomainMapping(createDomainMappingOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(domainMapping, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ComponentRef componentRefModel = new ComponentRef.Builder()\n", " .name(\"my-app-1\")\n", " .resourceType(\"app_v2\")\n", " .build();\n", "CreateDomainMappingOptions createDomainMappingOptions = new CreateDomainMappingOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .component(componentRefModel)\n", " .name(\"www.example.com\")\n", " .tlsSecret(\"my-tls-secret\")\n", " .build();\n", "\n", "Response response = codeEngineService.createDomainMapping(createDomainMappingOptions).execute();\n", "DomainMapping domainMapping = response.getResult();\n", "\n", "System.out.println(domainMapping);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "// Request models needed by this operation.\n", "\n", "// ComponentRef\n", "const componentRefModel = {\n", " name: 'my-app-1',\n", " resource_type: 'app_v2',\n", "};\n", "\n", "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " component: componentRefModel,\n", " name: 'www.example.com',\n", " tlsSecret: 'my-tls-secret',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createDomainMapping(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "component_ref_model = {\n", " 'name': 'my-app-1',\n", " 'resource_type': 'app_v2',\n", "}\n", "\n", "response = code_engine_service.create_domain_mapping(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " component=component_ref_model,\n", " name='www.example.com',\n", " tls_secret='my-tls-secret',\n", ")\n", "domain_mapping = response.get_result()\n", "\n", "print(json.dumps(domain_mapping, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } }, "x-terraform-polling-delay": 20, "x-terraform-polling-operation": "get_domain_mapping", "x-terraform-polling-pending": [ "deploying" ], "x-terraform-polling-property": "status", "x-terraform-polling-success": [ "ready", "failed" ], "x-terraform-polling-timeout": 600 } }, "/projects/{project_id}/domain_mappings/{name}": { "delete": { "description": "Delete a domain mapping", "operationId": "delete_domain_mapping", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a domain mapping", "tags": [ "Domain mappings" ], "x-ibm-events": { "events": [ { "name": "codeengine.domainmapping.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteDomainMappingOptions := codeEngineService.NewDeleteDomainMappingOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"www.example.com\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteDomainMapping(deleteDomainMappingOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteDomainMapping(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteDomainMappingOptions deleteDomainMappingOptions = new DeleteDomainMappingOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"www.example.com\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteDomainMapping(deleteDomainMappingOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'www.example.com',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteDomainMapping(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_domain_mapping(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='www.example.com',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Get domain mapping", "operationId": "get_domain_mapping", "responses": { "200": { "content": { "application/json": { "example": { "cname_target": "custom.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "component": { "name": "my-app", "resource_type": "app_v2" }, "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "www.example.com", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "domain_mapping_v2", "status": "ready", "tls_secret": "my-tls-secret", "user_managed": true, "visibility": "custom" }, "schema": { "$ref": "#/components/schemas/DomainMapping" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the domain mapping", "schema": { "description": "version of the domain mapping", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a domain mapping", "tags": [ "Domain mappings" ], "x-ibm-events": { "events": [ { "name": "codeengine.domainmapping.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getDomainMappingOptions := codeEngineService.NewGetDomainMappingOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"www.example.com\",\n", ")\n", "\n", "domainMapping, response, err := codeEngineService.GetDomainMapping(getDomainMappingOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(domainMapping, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetDomainMappingOptions getDomainMappingOptions = new GetDomainMappingOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"www.example.com\")\n", " .build();\n", "\n", "Response response = codeEngineService.getDomainMapping(getDomainMappingOptions).execute();\n", "DomainMapping domainMapping = response.getResult();\n", "\n", "System.out.println(domainMapping);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'www.example.com',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getDomainMapping(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_domain_mapping(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='www.example.com',\n", ")\n", "domain_mapping = response.get_result()\n", "\n", "print(json.dumps(domain_mapping, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your domain mapping.", "example": "www.example.com", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)+$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "patch": { "description": "Update a domain mapping", "operationId": "update_domain_mapping", "parameters": [ { "description": "Version of the domain mapping to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the domain mapping. This value helps identify parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/DomainMappingPatch" } } }, "description": "DomainMapping patch", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "cname_target": "custom.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "component": { "name": "my-app", "resource_type": "app_v2" }, "created_at": "2022-11-15T11:31:27+01:00", "entity_tag": "2385407409", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com", "id": "27587824-aba8-4f70-8c1d-416326907049", "name": "www.example.com", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "domain_mapping_v2", "status": "ready", "tls_secret": "my-tls-secret", "user_managed": true, "visibility": "custom" }, "schema": { "$ref": "#/components/schemas/DomainMapping" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the domain mapping", "schema": { "description": "version of the domain mapping", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update a domain mapping", "tags": [ "Domain mappings" ], "x-codegen-request-body-name": "domain_mapping", "x-ibm-events": { "events": [ { "name": "codeengine.domainmapping.read" }, { "name": "codeengine.domainmapping.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PATCH\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/domain_mappings/www.example.com?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --header \"If-Match: *\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "domainMappingPatchModel := &codeenginev2.DomainMappingPatch{}\n", "domainMappingPatchModelAsPatch, asPatchErr := domainMappingPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateDomainMappingOptions := codeEngineService.NewUpdateDomainMappingOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"www.example.com\",\n", " \"testString\",\n", " domainMappingPatchModelAsPatch,\n", ")\n", "\n", "domainMapping, response, err := codeEngineService.UpdateDomainMapping(updateDomainMappingOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(domainMapping, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DomainMappingPatch domainMappingPatchModel = new DomainMappingPatch.Builder()\n", " .build();\n", "Map domainMappingPatchModelAsPatch = domainMappingPatchModel.asPatch();\n", "UpdateDomainMappingOptions updateDomainMappingOptions = new UpdateDomainMappingOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"www.example.com\")\n", " .ifMatch(\"testString\")\n", " .domainMapping(domainMappingPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = codeEngineService.updateDomainMapping(updateDomainMappingOptions).execute();\n", "DomainMapping domainMapping = response.getResult();\n", "\n", "System.out.println(domainMapping);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'www.example.com',\n", " ifMatch: 'testString',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.updateDomainMapping(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "domain_mapping_patch_model = {}\n", "\n", "response = code_engine_service.update_domain_mapping(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='www.example.com',\n", " if_match='testString',\n", " domain_mapping=domain_mapping_patch_model,\n", ")\n", "domain_mapping = response.get_result()\n", "\n", "print(json.dumps(domain_mapping, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/egress_ips": { "get": { "description": "Lists all egress IP addresses (public and private) that are used by components running in this project. For information about using egress IP addresses, see [Code Engine public and private IP addresses](https://cloud.ibm.com/docs/codeengine?topic=codeengine-network-addresses).", "operationId": "get_project_egress_ips", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "responses": { "200": { "content": { "application/json": { "example": { "private": [ "10.223.236.11", "10.223.242.142", "10.12.3.244" ], "public": [ "159.23.99.151", "130.198.13.241", "135.90.137.31" ] }, "schema": { "$ref": "#/components/schemas/ProjectEgressIPAddresses" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List egress IP addresses", "tags": [ "Projects" ], "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/egress_ips?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getProjectEgressIpsOptions := codeEngineService.NewGetProjectEgressIpsOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", ")\n", "\n", "projectEgressIpAddresses, response, err := codeEngineService.GetProjectEgressIps(getProjectEgressIpsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(projectEgressIpAddresses, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetProjectEgressIpsOptions getProjectEgressIpsOptions = new GetProjectEgressIpsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .build();\n", "\n", "Response response = codeEngineService.getProjectEgressIps(getProjectEgressIpsOptions).execute();\n", "ProjectEgressIPAddresses projectEgressIpAddresses = response.getResult();\n", "\n", "System.out.println(projectEgressIpAddresses);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getProjectEgressIps(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_project_egress_ips(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", ")\n", "project_egress_ip_addresses = response.get_result()\n", "\n", "print(json.dumps(project_egress_ip_addresses, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/fleets": { "get": { "description": "List all fleets in a project.", "operationId": "list_fleets", "parameters": [ { "description": "Optional maximum number of fleets per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets?limit=50" }, "fleets": [ { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30", "id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "image_reference": "icr.io/codeengine/helloworld", "image_secret": "my-access-secret", "name": "my-fleet-123", "network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_v2", "run_arguments": [], "run_commands": [], "run_env_variables": [], "run_volume_mounts": [], "scale_cpu_limit": "4", "scale_gpu_limit": 1, "scale_max_execution_time": "2h30m", "scale_max_instances": 10, "scale_memory_limit": "16G", "scale_retry_limit": 3, "scale_worker_profile": "gx2-8x64x1v100", "status": "running", "status_details": { "task_progress": { "canceled": 0, "failed": 0, "pending": 45, "running": 42, "succeeded": 13 } }, "tasks_specification": { "indices": "0-99" }, "tasks_state_store": { "persistent_data_store": "my-persistent-storage", "sub_path": "/my/bucket/data" } } ], "limit": 50, "next": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets?limit=50&start=eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ", "start": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ" } }, "schema": { "$ref": "#/components/schemas/FleetList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List fleets", "tags": [ "Fleets" ], "x-ibm-events": { "events": [ { "name": "codeengine.fleet.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ], "post": { "description": "Create a fleet.", "operationId": "create_fleet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetPrototype" } } }, "description": "Fleet prototype.", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30", "id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "image_reference": "icr.io/codeengine/helloworld", "image_secret": "my-access-secret", "name": "my-fleet-123", "network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_v2", "run_arguments": [], "run_commands": [], "run_env_variables": [], "run_volume_mounts": [], "scale_cpu_limit": "4", "scale_gpu_limit": 1, "scale_max_execution_time": "2h30m", "scale_max_instances": 10, "scale_memory_limit": "16G", "scale_retry_limit": 3, "scale_worker_profile": "gx2-8x64x1v100", "status": "running", "status_details": { "task_progress": { "canceled": 0, "failed": 0, "pending": 45, "running": 42, "succeeded": 13 } }, "tasks_specification": { "indices": "0-99" }, "tasks_state_store": { "persistent_data_store": "my-persistent-storage", "sub_path": "/my/bucket/data" } }, "schema": { "$ref": "#/components/schemas/Fleet" } } }, "description": "Created" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a fleet", "tags": [ "Fleets" ], "x-codegen-request-body-name": "fleet", "x-ibm-events": { "events": [ { "name": "codeengine.fleet.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"image_reference\": \"icr.io/codeengine/helloworld\",\n \"name\": \"my-fleet-123\",\n \"network_placements\": [\n {\n \"reference\": \"b5e300ed-50c9-4775-b29c-03f6a67ac41f\",\n \"type\": \"subnet_pool\"\n }\n ],\n \"scale_cpu_limit\": \"4\",\n \"scale_max_instances\": 10,\n \"scale_memory_limit\": \"16G\",\n \"tasks_state_store\": {\n \"persistent_data_store\": \"my-persistent-storage\",\n \"sub_path\": \"/my/bucket/data\"\n }\n}'" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/fleets/{fleet_id}/tasks": { "get": { "description": "List tasks.", "operationId": "list_fleet_tasks", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the fleet.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "fleet_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "Status condition to filter the tasks by", "example": "running", "in": "query", "name": "status", "schema": { "enum": [ "pending", "running", "succeeded", "failed", "canceled" ], "type": "string" } }, { "description": "Optional maximum number of subnet pools per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks_by_status/finished?limit=50" }, "limit": 50, "next": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks_by_status/finished?limit=50&start=eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ", "start": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ" }, "tasks": [ { "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks/ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "id": "ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "index": "1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_task_v2", "status": "running", "worker_name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0" } ] }, "schema": { "$ref": "#/components/schemas/TaskList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List tasks", "tags": [ "Fleets" ], "x-ibm-events": { "events": [ { "name": "codeengine.task.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9/tasks?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/fleets/{fleet_id}/tasks/{id}": { "get": { "description": "Get a task.", "operationId": "get_fleet_task", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the fleet.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "fleet_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the task.", "example": "b96d0a61-c1db-4ca2-98c1-3cfdb268b157", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2025-03-13T11:41:35Z", "finished_at": "2025-03-13T13:41:35Z", "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/tasks/ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "id": "ab5eb341-2d55-4f85-9976-d6ae6e2f41fc", "index": "1", "process_id": "93375", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_task_v2", "retries": 1, "status": "succeeded", "worker_name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0" }, "schema": { "$ref": "#/components/schemas/Task" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a task", "tags": [ "Fleets" ], "x-ibm-events": { "events": [ { "name": "codeengine.task.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9/tasks/b96d0a61-c1db-4ca2-98c1-3cfdb268b157?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/fleets/{fleet_id}/workers": { "get": { "description": "List workers.", "operationId": "list_fleet_workers", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the fleet.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "fleet_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers?limit=50" }, "limit": 50, "next": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers?limit=50&start=eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ", "start": "eyJ2IjoibWV0YS5rOHMuaW8vdjEiLCJydiI6MTMyOTUyMDk2MjgsInN0YXJ0IjoiYXBwbGljYXRpb24tZGJcdTAwMDAifQ" }, "workers": [ { "created_at": "2025-03-13T11:41:35Z", "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers/fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "id": "6d0cd963-55c9-465e-bb92-032c0e3de3f4", "name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_worker_v2", "status": "running", "status_details": { "address": "10.244.0.4", "image_version": "v1.0.15", "profile": "gx2-8x64x1v100", "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "zone": "eu-de-1" } } ] }, "schema": { "$ref": "#/components/schemas/WorkerList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List workers", "tags": [ "Fleets" ], "x-ibm-events": { "events": [ { "name": "codeengine.worker.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9/workers?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/fleets/{fleet_id}/workers/{name}": { "get": { "description": "Get a worker.", "operationId": "get_fleet_worker", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the fleet.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "fleet_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of the worker.", "example": "fleet-b96d0a61-c1db-4ca2-98c1-3cfdb268b157-1", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 44, "pattern": "^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2025-03-13T11:41:35Z", "fleet_id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "href": "https: //api.eu-de.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30/workers/fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "id": "6d0cd963-55c9-465e-bb92-032c0e3de3f4", "name": "fleet-3af87ebb-4480-43f2-aad3-73d0d2328f30-0", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_worker_v2", "status": "running", "status_details": { "address": "10.244.0.4", "image_version": "v1.0.15", "profile": "gx2-8x64x1v100", "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56", "zone": "eu-de-1" } }, "schema": { "$ref": "#/components/schemas/Worker" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a worker", "tags": [ "Fleets" ], "x-ibm-events": { "events": [ { "name": "codeengine.worker.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9/workers/fleet-b96d0a61-c1db-4ca2-98c1-3cfdb268b157-1?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/fleets/{id}": { "delete": { "description": "Delete a fleet.", "operationId": "delete_fleet", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a fleet", "tags": [ "Fleets" ], "x-ibm-events": { "events": [ { "name": "codeengine.fleet.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Get a fleet.", "operationId": "get_fleet", "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30", "id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "image_reference": "icr.io/codeengine/helloworld", "image_secret": "my-access-secret", "name": "my-fleet-123", "network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_v2", "run_arguments": [], "run_commands": [], "run_env_variables": [], "run_volume_mounts": [], "scale_cpu_limit": "4", "scale_gpu_limit": 1, "scale_max_execution_time": "2h30m", "scale_max_instances": 10, "scale_memory_limit": "16G", "scale_retry_limit": 3, "scale_worker_profile": "gx2-8x64x1v100", "status": "running", "status_details": { "task_progress": { "canceled": 0, "failed": 0, "pending": 45, "running": 42, "succeeded": 13 } }, "tasks_specification": { "indices": "0-99" }, "tasks_state_store": { "persistent_data_store": "my-persistent-storage", "sub_path": "/my/bucket/data" } }, "schema": { "$ref": "#/components/schemas/Fleet" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a fleet", "tags": [ "Fleets" ], "x-ibm-events": { "events": [ { "name": "codeengine.fleet.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the fleet.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ] }, "/projects/{project_id}/fleets/{id}/add_tasks": { "post": { "description": "Add tasks to a fleet.", "operationId": "add_tasks_fleet", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the fleet.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetAddTasksPrototype" } } }, "description": "Add tasks request.", "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "id": "ab5eb341-2d55-4f85-9976-d6ae6e2f41fc" }, "schema": { "$ref": "#/components/schemas/FleetAddTasks" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Add tasks to a fleet", "tags": [ "Fleets" ], "x-codegen-request-body-name": "request", "x-ibm-events": { "events": [ { "name": "codeengine.fleet.action.addtasks.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9/add_tasks?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"tasks_specification\": {\n \"indices\": \"0-9\"\n }\n}'" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/fleets/{id}/cancel": { "post": { "description": "Cancel a fleet.", "operationId": "cancel_fleet", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the fleet.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetCancel" } } }, "description": "Fleet cancel request." }, "responses": { "202": { "content": { "application/json": { "example": { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/3af87ebb-4480-43f2-aad3-73d0d2328f30", "id": "3af87ebb-4480-43f2-aad3-73d0d2328f30", "image_reference": "icr.io/codeengine/helloworld", "image_secret": "my-access-secret", "name": "my-fleet-123", "network_placements": [ { "reference": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "type": "subnet_pool" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "fleet_v2", "run_arguments": [], "run_commands": [], "run_env_variables": [], "run_volume_mounts": [], "scale_cpu_limit": "4", "scale_gpu_limit": 1, "scale_max_execution_time": "2h30m", "scale_max_instances": 10, "scale_memory_limit": "16G", "scale_retry_limit": 3, "scale_worker_profile": "gx2-8x64x1v100", "status": "running", "status_details": { "task_progress": { "canceled": 0, "failed": 0, "pending": 45, "running": 42, "succeeded": 13 } }, "tasks_specification": { "indices": "0-99" }, "tasks_state_store": { "persistent_data_store": "my-persistent-storage", "sub_path": "/my/bucket/data" } }, "schema": { "$ref": "#/components/schemas/Fleet" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Cancel a fleet", "tags": [ "Fleets" ], "x-codegen-request-body-name": "fleet", "x-ibm-events": { "events": [ { "name": "codeengine.fleet.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/fleets/d0cb584c-8d17-4709-a2b3-769ccd90ced9/cancel?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/functions": { "get": { "description": "List all functions in a project.", "operationId": "list_functions", "parameters": [ { "description": "Optional maximum number of functions per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the 'next_url' field of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "functions": [ { "code_binary": true, "code_reference": "icr.io/codeengine/samples/function-nodejs-codebundle", "code_secret": "my-secret", "computed_env_variables": [ { "name": "CE_API_BASE_URL", "type": "literal", "value": "https://api.us-east.codeengine.cloud.ibm.com" }, { "name": "CE_DOMAIN", "type": "literal", "value": "us-east.codeengine.appdomain.cloud" }, { "name": "CE_FUNCTION", "type": "literal", "value": "my-function" }, { "name": "CE_REGION", "type": "literal", "value": "us-east" }, { "name": "CE_SUBDOMAIN", "type": "literal", "value": "uyh5shf7s0f" }, { "name": "CE_PROJECT_ID", "type": "literal", "value": "15314cc3-85b4-4338-903f-c28cdee6d005" } ], "created_at": "2023-11-15T22:07:55Z", "endpoint": "https://my-function.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "endpoint_internal": "http://my-function.uyh5shf7s0f.function.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "managed_domain_mappings": "local_public", "name": "my-function", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "function_v2", "run_compute_resource_token_enabled": false, "run_env_variables": [], "runtime": "nodejs-24", "scale_concurrency": 1, "scale_cpu_limit": "0.5", "scale_down_delay": 0, "scale_max_execution_time": 60, "scale_memory_limit": "2G", "status": "ready", "status_details": { "reason": "ready" } } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/FunctionList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List functions", "tags": [ "Functions" ], "x-ibm-events": { "events": [ { "name": "codeengine.function.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listFunctionsOptions := &codeenginev2.ListFunctionsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewFunctionsPager(listFunctionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.Function\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListFunctionsOptions listFunctionsOptions = new ListFunctionsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "FunctionsPager pager = new FunctionsPager(codeEngineService, listFunctionsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.FunctionsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = FunctionsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a function.", "operationId": "create_function", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FunctionPrototype" } } }, "description": "Function prototype", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "code_binary": false, "code_reference": "data:text/plain;base64,", "computed_env_variables": [], "created_at": "2023-11-15T22:07:55Z", "endpoint": "https://my-function.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "endpoint_internal": "http://my-function.uyh5shf7s0f.function.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "managed_domain_mappings": "local_public", "name": "my-function", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "function_v2", "run_compute_resource_token_enabled": false, "run_env_variables": [], "runtime": "nodejs-24", "scale_concurrency": 1, "scale_cpu_limit": "0.5", "scale_down_delay": 0, "scale_max_execution_time": 60, "scale_memory_limit": "2G", "status": "ready", "status_details": { "reason": "ready" } }, "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the function", "schema": { "description": "version of the function", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a function", "tags": [ "Functions" ], "x-codegen-request-body-name": "function", "x-ibm-events": { "events": [ { "name": "codeengine.function.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"my-function\",\n \"runtime\": \"nodejs-24\",\n \"code_reference\": \"data:text/plain;base64,\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createFunctionOptions := codeEngineService.NewCreateFunctionOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"data:text/plain;base64,\",\n", " \"my-function\",\n", " \"nodejs-24\",\n", ")\n", "\n", "function, response, err := codeEngineService.CreateFunction(createFunctionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(function, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateFunctionOptions createFunctionOptions = new CreateFunctionOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .codeReference(\"data:text/plain;base64,\")\n", " .name(\"my-function\")\n", " .runtime(\"nodejs-24\")\n", " .build();\n", "\n", "Response response = codeEngineService.createFunction(createFunctionOptions).execute();\n", "Function function = response.getResult();\n", "\n", "System.out.println(function);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " codeReference: 'data:text/plain;base64,',\n", " name: 'my-function',\n", " runtime: 'nodejs-24',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createFunction(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_function(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " code_reference='data:text/plain;base64,',\n", " name='my-function',\n", " runtime='nodejs-24',\n", ")\n", "function = response.get_result()\n", "\n", "print(json.dumps(function, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } }, "x-terraform-polling-delay": 20, "x-terraform-polling-operation": "get_function", "x-terraform-polling-pending": [ "deploying" ], "x-terraform-polling-property": "status", "x-terraform-polling-success": [ "ready", "failed", "offline" ], "x-terraform-polling-timeout": 600 } }, "/projects/{project_id}/functions/{name}": { "delete": { "description": "Delete a function.", "operationId": "delete_function", "parameters": [ { "description": "Determines if connected service access secrets remain intact after function deletion.", "in": "query", "name": "keep_service_access", "schema": { "default": false, "type": "boolean" } } ], "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a function", "tags": [ "Functions" ], "x-ibm-events": { "events": [ { "name": "codeengine.function.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteFunctionOptions := codeEngineService.NewDeleteFunctionOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-function\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteFunction(deleteFunctionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteFunction(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteFunctionOptions deleteFunctionOptions = new DeleteFunctionOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-function\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteFunction(deleteFunctionOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-function',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteFunction(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_function(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-function',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a function.", "operationId": "get_function", "responses": { "200": { "content": { "application/json": { "example": { "code_binary": false, "code_reference": "data:text/plain;base64,", "computed_env_variables": [], "created_at": "2023-11-15T22:07:55Z", "endpoint": "https://my-function.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "endpoint_internal": "http://my-function.uyh5shf7s0f.function.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "managed_domain_mappings": "local_public", "name": "my-function", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "function_v2", "run_compute_resource_token_enabled": false, "run_env_variables": [], "runtime": "nodejs-24", "scale_concurrency": 1, "scale_cpu_limit": "0.5", "scale_down_delay": 0, "scale_max_execution_time": 60, "scale_memory_limit": "2G", "status": "ready", "status_details": { "reason": "ready" } }, "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the function", "schema": { "description": "version of the function", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a function", "tags": [ "Functions" ], "x-ibm-events": { "events": [ { "name": "codeengine.function.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getFunctionOptions := codeEngineService.NewGetFunctionOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-function\",\n", ")\n", "\n", "function, response, err := codeEngineService.GetFunction(getFunctionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(function, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetFunctionOptions getFunctionOptions = new GetFunctionOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-function\")\n", " .build();\n", "\n", "Response response = codeEngineService.getFunction(getFunctionOptions).execute();\n", "Function function = response.getResult();\n", "\n", "System.out.println(function);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-function',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getFunction(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_function(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-function',\n", ")\n", "function = response.get_result()\n", "\n", "print(json.dumps(function, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your function.", "example": "my-function", "in": "path", "name": "name", "required": true, "schema": { "example": "my-function", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "patch": { "description": "Update the given function.", "operationId": "update_function", "parameters": [ { "description": "Version of the function settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the function. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/FunctionPatch" } } }, "description": "Function patch", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "code_binary": false, "code_reference": "data:text/plain;base64,", "computed_env_variables": [], "created_at": "2023-11-15T22:07:55Z", "endpoint": "https://my-function.uyh5shf7s0f.us-east.codeengine.appdomain.cloud", "endpoint_internal": "http://my-function.uyh5shf7s0f.function.cluster.local", "entity_tag": "1", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "managed_domain_mappings": "local_public", "name": "my-function", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "function_v2", "run_compute_resource_token_enabled": false, "run_env_variables": [], "runtime": "nodejs-24", "scale_concurrency": 1, "scale_cpu_limit": "0.5", "scale_down_delay": 0, "scale_max_execution_time": 60, "scale_memory_limit": "2G", "status": "ready", "status_details": { "reason": "ready" } }, "schema": { "$ref": "#/components/schemas/Function" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the function", "schema": { "description": "version of the function", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update a function", "tags": [ "Functions" ], "x-codegen-request-body-name": "function", "x-ibm-events": { "events": [ { "name": "codeengine.function.read" }, { "name": "codeengine.function.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PATCH\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/functions/my-function?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --header \"If-Match: *\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "functionPatchModel := &codeenginev2.FunctionPatch{}\n", "functionPatchModelAsPatch, asPatchErr := functionPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateFunctionOptions := codeEngineService.NewUpdateFunctionOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-function\",\n", " \"testString\",\n", " functionPatchModelAsPatch,\n", ")\n", "\n", "function, response, err := codeEngineService.UpdateFunction(updateFunctionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(function, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "FunctionPatch functionPatchModel = new FunctionPatch.Builder()\n", " .build();\n", "Map functionPatchModelAsPatch = functionPatchModel.asPatch();\n", "UpdateFunctionOptions updateFunctionOptions = new UpdateFunctionOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-function\")\n", " .ifMatch(\"testString\")\n", " .function(functionPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = codeEngineService.updateFunction(updateFunctionOptions).execute();\n", "Function function = response.getResult();\n", "\n", "System.out.println(function);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-function',\n", " ifMatch: 'testString',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.updateFunction(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "function_patch_model = {}\n", "\n", "response = code_engine_service.update_function(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-function',\n", " if_match='testString',\n", " function=function_patch_model,\n", ")\n", "function = response.get_result()\n", "\n", "print(json.dumps(function, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/job_runs": { "get": { "description": "List all job runs in a project.", "operationId": "list_job_runs", "parameters": [ { "description": "Optional name of the job that you want to use to filter.", "example": "my-job", "in": "query", "name": "job_name", "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "description": "Optional maximum number of job runs per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "job_runs": [ { "computed_env_variables": [], "created_at": "2022-11-15T22:06:21+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job-run-1", "id": "ced5039e-b1d3-4c51-aa29-8dbde3531ace", "image_reference": "icr.io/codeengine/helloworld", "job_name": "my-job", "name": "my-job-run-1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_run_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3, "status": "completed", "status_details": { "completion_time": "2024-10-31T13:17:18Z", "failed": 1, "failed_indices": "1", "indices_details": { "0": { "finished_at": "2024-10-31T12:13:15Z", "retries": 0, "started_at": "2024-10-31T12:12:05Z", "status": "succeeded" }, "1": { "finished_at": "2024-10-31T12:16:50Z", "last_failure_reason": "ExceededEphemeralStorage", "retries": 3, "started_at": "2024-10-31T12:12:05Z", "status": "failed" } }, "start_time": "2024-10-31T13:11:48Z", "succeedded": 1, "succeeded_indices": "0" } } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/JobRunList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List job runs", "tags": [ "Jobs" ], "x-ibm-events": { "events": [ { "name": "codeengine.jobrun.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/job_runs?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listJobRunsOptions := &codeenginev2.ListJobRunsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " JobName: core.StringPtr(\"my-job\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewJobRunsPager(listJobRunsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.JobRun\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListJobRunsOptions listJobRunsOptions = new ListJobRunsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .jobName(\"my-job\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "JobRunsPager pager = new JobRunsPager(codeEngineService, listJobRunsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " jobName: 'my-job',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.JobRunsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = JobRunsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " job_name='my-job',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create an job run.", "operationId": "create_job_run", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRunPrototype" } } }, "description": "Job run prototype", "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "computed_env_variables": [], "created_at": "2022-11-15T22:06:21+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job-run-1", "id": "ced5039e-b1d3-4c51-aa29-8dbde3531ace", "image_reference": "icr.io/codeengine/helloworld", "job_name": "my-job", "name": "my-job-run-1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_run_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_volume_mounts": [], "scale_array_spec": "0-1", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3, "status": "completed", "status_details": { "completion_time": "2024-10-31T13:17:18Z", "failed": 1, "failed_indices": "1", "indices_details": { "0": { "finished_at": "2024-10-31T12:13:15Z", "retries": 0, "started_at": "2024-10-31T12:12:05Z", "status": "succeeded" }, "1": { "finished_at": "2024-10-31T12:16:50Z", "last_failure_reason": "ExceededEphemeralStorage", "retries": 3, "started_at": "2024-10-31T12:12:05Z", "status": "failed" } }, "start_time": "2024-10-31T13:11:48Z", "succeedded": 1, "succeeded_indices": "0" } }, "schema": { "$ref": "#/components/schemas/JobRun" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a job run", "tags": [ "Jobs" ], "x-codegen-request-body-name": "job", "x-ibm-events": { "events": [ { "name": "codeengine.jobrun.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/job_runs?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createJobRunOptions := codeEngineService.NewCreateJobRunOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", ")\n", "\n", "jobRun, response, err := codeEngineService.CreateJobRun(createJobRunOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(jobRun, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateJobRunOptions createJobRunOptions = new CreateJobRunOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .build();\n", "\n", "Response response = codeEngineService.createJobRun(createJobRunOptions).execute();\n", "JobRun jobRun = response.getResult();\n", "\n", "System.out.println(jobRun);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createJobRun(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_job_run(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", ")\n", "job_run = response.get_result()\n", "\n", "print(json.dumps(job_run, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/job_runs/{name}": { "delete": { "description": "Delete a job run.", "operationId": "delete_job_run", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a job run", "tags": [ "Jobs" ], "x-ibm-events": { "events": [ { "name": "codeengine.jobrun.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/job_runs/my-job-run?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteJobRunOptions := codeEngineService.NewDeleteJobRunOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-job-run\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteJobRun(deleteJobRunOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteJobRun(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteJobRunOptions deleteJobRunOptions = new DeleteJobRunOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-job-run\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteJobRun(deleteJobRunOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-job-run',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteJobRun(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_job_run(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-job-run',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a job run.", "operationId": "get_job_run", "responses": { "200": { "content": { "application/json": { "example": { "computed_env_variables": [], "created_at": "2022-11-15T22:06:21+01:00", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job-run-1", "id": "ced5039e-b1d3-4c51-aa29-8dbde3531ace", "image_reference": "icr.io/codeengine/helloworld", "job_name": "my-job", "name": "my-job-run-1", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_run_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_volume_mounts": [], "scale_array_spec": "0-1", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3, "status": "completed", "status_details": { "completion_time": "2024-10-31T13:17:18Z", "failed": 1, "failed_indices": "1", "indices_details": { "0": { "finished_at": "2024-10-31T12:13:15Z", "retries": 0, "started_at": "2024-10-31T12:12:05Z", "status": "succeeded" }, "1": { "finished_at": "2024-10-31T12:16:50Z", "last_failure_reason": "ExceededEphemeralStorage", "retries": 3, "started_at": "2024-10-31T12:12:05Z", "status": "failed" } }, "start_time": "2024-10-31T13:11:48Z", "succeedded": 1, "succeeded_indices": "0" } }, "schema": { "$ref": "#/components/schemas/JobRun" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a job run", "tags": [ "Jobs" ], "x-ibm-events": { "events": [ { "name": "codeengine.jobrun.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/job_runs/my-job-run?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getJobRunOptions := codeEngineService.NewGetJobRunOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-job-run\",\n", ")\n", "\n", "jobRun, response, err := codeEngineService.GetJobRun(getJobRunOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(jobRun, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetJobRunOptions getJobRunOptions = new GetJobRunOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-job-run\")\n", " .build();\n", "\n", "Response response = codeEngineService.getJobRun(getJobRunOptions).execute();\n", "JobRun jobRun = response.getResult();\n", "\n", "System.out.println(jobRun);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-job-run',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getJobRun(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_job_run(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-job-run',\n", ")\n", "job_run = response.get_result()\n", "\n", "print(json.dumps(job_run, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your job run.", "example": "my-job-run", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 53, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ] }, "/projects/{project_id}/jobs": { "get": { "description": "List all jobs in a project.", "operationId": "list_jobs", "parameters": [ { "description": "Optional maximum number of jobs per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "jobs": [ { "computed_env_variables": [], "created_at": "2022-11-15T21:40:40+01:00", "entity_tag": "2386231540", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job", "id": "7e49dd78-09d0-45c7-ad7e-cd968e0e7747", "image_reference": "icr.io/codeengine/helloworld", "name": "my-job", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_service_account": "default", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3, "status": "ready" } ], "limit": 50 }, "schema": { "$ref": "#/components/schemas/JobList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List jobs", "tags": [ "Jobs" ], "x-ibm-events": { "events": [ { "name": "codeengine.job.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listJobsOptions := &codeenginev2.ListJobsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewJobsPager(listJobsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.Job\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListJobsOptions listJobsOptions = new ListJobsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "JobsPager pager = new JobsPager(codeEngineService, listJobsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.JobsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = JobsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a job.", "operationId": "create_job", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPrototype" } } }, "description": "Job prototype", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "computed_env_variables": [], "created_at": "2022-11-15T21:40:40+01:00", "entity_tag": "2386231540", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job", "id": "7e49dd78-09d0-45c7-ad7e-cd968e0e7747", "image_reference": "icr.io/codeengine/helloworld", "name": "my-job", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_service_account": "default", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3 }, "schema": { "$ref": "#/components/schemas/Job" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the job", "schema": { "description": "version of the job", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a job", "tags": [ "Jobs" ], "x-codegen-request-body-name": "job", "x-ibm-events": { "events": [ { "name": "codeengine.job.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"image_reference\": \"icr.io/codeengine/helloworld\",\n \"name\": \"my-job\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createJobOptions := codeEngineService.NewCreateJobOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"icr.io/codeengine/helloworld\",\n", " \"my-job\",\n", ")\n", "\n", "job, response, err := codeEngineService.CreateJob(createJobOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(job, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateJobOptions createJobOptions = new CreateJobOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .imageReference(\"icr.io/codeengine/helloworld\")\n", " .name(\"my-job\")\n", " .build();\n", "\n", "Response response = codeEngineService.createJob(createJobOptions).execute();\n", "Job job = response.getResult();\n", "\n", "System.out.println(job);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " imageReference: 'icr.io/codeengine/helloworld',\n", " name: 'my-job',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createJob(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_job(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " image_reference='icr.io/codeengine/helloworld',\n", " name='my-job',\n", ")\n", "job = response.get_result()\n", "\n", "print(json.dumps(job, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/jobs/{name}": { "delete": { "description": "Delete a job.", "operationId": "delete_job", "parameters": [ { "description": "Determines if connected service access secrets remain intact after job deletion.", "in": "query", "name": "keep_service_access", "schema": { "default": false, "type": "boolean" } } ], "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a job", "tags": [ "Jobs" ], "x-ibm-events": { "events": [ { "name": "codeengine.job.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteJobOptions := codeEngineService.NewDeleteJobOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-job\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteJob(deleteJobOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteJob(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteJobOptions deleteJobOptions = new DeleteJobOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-job\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteJob(deleteJobOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-job',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteJob(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_job(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-job',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Display the details of a job.", "operationId": "get_job", "responses": { "200": { "content": { "application/json": { "example": { "computed_env_variables": [], "created_at": "2022-11-15T21:40:40+01:00", "entity_tag": "2386231540", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job", "id": "7e49dd78-09d0-45c7-ad7e-cd968e0e7747", "image_reference": "icr.io/codeengine/helloworld", "name": "my-job", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_service_account": "default", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3 }, "schema": { "$ref": "#/components/schemas/Job" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the job", "schema": { "description": "version of the job", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a job", "tags": [ "Jobs" ], "x-ibm-events": { "events": [ { "name": "codeengine.job.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getJobOptions := codeEngineService.NewGetJobOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-job\",\n", ")\n", "\n", "job, response, err := codeEngineService.GetJob(getJobOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(job, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetJobOptions getJobOptions = new GetJobOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-job\")\n", " .build();\n", "\n", "Response response = codeEngineService.getJob(getJobOptions).execute();\n", "Job job = response.getResult();\n", "\n", "System.out.println(job);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-job',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getJob(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_job(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-job',\n", ")\n", "job = response.get_result()\n", "\n", "print(json.dumps(job, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your job.", "example": "my-job", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "patch": { "description": "Update the given job.", "operationId": "update_job", "parameters": [ { "description": "Version of the job settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the job. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/JobPatch" } } }, "description": "Job patch prototype", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "computed_env_variables": [], "created_at": "2022-11-15T21:40:40+01:00", "entity_tag": "2386231540", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job", "id": "7e49dd78-09d0-45c7-ad7e-cd968e0e7747", "image_reference": "icr.io/codeengine/helloworld", "name": "my-job", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "job_v2", "run_arguments": [], "run_commands": [], "run_compute_resource_token_enabled": false, "run_env_variables": [], "run_mode": "task", "run_service_account": "default", "run_volume_mounts": [], "scale_array_spec": "0", "scale_cpu_limit": "1", "scale_ephemeral_storage_limit": "400M", "scale_max_execution_time": 7200, "scale_memory_limit": "4G", "scale_retry_limit": 3 }, "schema": { "$ref": "#/components/schemas/Job" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the job", "schema": { "description": "version of the job", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update a job", "tags": [ "Jobs" ], "x-codegen-request-body-name": "job", "x-ibm-events": { "events": [ { "name": "codeengine.job.read" }, { "name": "codeengine.job.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PATCH\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/jobs/my-job?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/merge-patch+json\" \\\n", " --header \"If-Match: *\" \\\n", " --data '{}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "jobPatchModel := &codeenginev2.JobPatch{}\n", "jobPatchModelAsPatch, asPatchErr := jobPatchModel.AsPatch()\n", "Expect(asPatchErr).To(BeNil())\n", "\n", "updateJobOptions := codeEngineService.NewUpdateJobOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-job\",\n", " \"testString\",\n", " jobPatchModelAsPatch,\n", ")\n", "\n", "job, response, err := codeEngineService.UpdateJob(updateJobOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(job, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "JobPatch jobPatchModel = new JobPatch.Builder()\n", " .build();\n", "Map jobPatchModelAsPatch = jobPatchModel.asPatch();\n", "UpdateJobOptions updateJobOptions = new UpdateJobOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-job\")\n", " .ifMatch(\"testString\")\n", " .job(jobPatchModelAsPatch)\n", " .build();\n", "\n", "Response response = codeEngineService.updateJob(updateJobOptions).execute();\n", "Job job = response.getResult();\n", "\n", "System.out.println(job);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-job',\n", " ifMatch: 'testString',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.updateJob(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "job_patch_model = {}\n", "\n", "response = code_engine_service.update_job(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-job',\n", " if_match='testString',\n", " job=job_patch_model,\n", ")\n", "job = response.get_result()\n", "\n", "print(json.dumps(job, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/persistent_data_stores": { "get": { "description": "List all persistent data stores in a project.", "operationId": "list_persistent_data_stores", "parameters": [ { "description": "Optional maximum number of persistent data stores per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "limit": 50, "persistent_data_stores": [ { "created_at": "2025-05-15T22:07:55+01:00", "data": { "bucket_location": "us-east", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "entity_tag": "2385407409", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "name": "my-persistent-data-store", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "persistent_data_store_v2", "storage_type": "object_storage" } ] }, "schema": { "$ref": "#/components/schemas/PersistentDataStoreList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List persistent data stores", "tags": [ "Persistent data stores" ], "x-ibm-events": { "events": [ { "name": "codeengine.persistentdatastore.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/persistent_data_stores?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listPersistentDataStoresOptions := &codeenginev2.ListPersistentDataStoresOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewPersistentDataStoresPager(listPersistentDataStoresOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.PersistentDataStore\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListPersistentDataStoresOptions listPersistentDataStoresOptions = new ListPersistentDataStoresOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "PersistentDataStoresPager pager = new PersistentDataStoresPager(codeEngineService, listPersistentDataStoresOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.PersistentDataStoresPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = PersistentDataStoresPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a persistent data store.", "operationId": "create_persistent_data_store", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistentDataStorePrototype" } } }, "description": "PersistentDataStore prototype", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "created_at": "2025-05-15T22:07:55+01:00", "data": { "bucket_location": "us-east", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "entity_tag": "2385407409", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "name": "my-persistent-data-store", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "persistent_data_store_v2", "storage_type": "object_storage" }, "schema": { "$ref": "#/components/schemas/PersistentDataStore" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the persistent data store", "schema": { "description": "version of the persistent data store", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a persistent data store", "tags": [ "Persistent data stores" ], "x-codegen-request-body-name": "persistent_storage", "x-ibm-events": { "events": [ { "name": "codeengine.persistentdatastore.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/persistent_data_stores?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"my-persistent-data-store\",\n \"storage_type\": \"object_storage\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createPersistentDataStoreOptions := codeEngineService.NewCreatePersistentDataStoreOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-persistent-data-store\",\n", " \"object_storage\",\n", ")\n", "\n", "persistentDataStore, response, err := codeEngineService.CreatePersistentDataStore(createPersistentDataStoreOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(persistentDataStore, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreatePersistentDataStoreOptions createPersistentDataStoreOptions = new CreatePersistentDataStoreOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-persistent-data-store\")\n", " .storageType(\"object_storage\")\n", " .build();\n", "\n", "Response response = codeEngineService.createPersistentDataStore(createPersistentDataStoreOptions).execute();\n", "PersistentDataStore persistentDataStore = response.getResult();\n", "\n", "System.out.println(persistentDataStore);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-persistent-data-store',\n", " storageType: 'object_storage',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createPersistentDataStore(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_persistent_data_store(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-persistent-data-store',\n", " storage_type='object_storage',\n", ")\n", "persistent_data_store = response.get_result()\n", "\n", "print(json.dumps(persistent_data_store, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } }, "x-terraform-polling-operation": "get_persistent_data_store" } }, "/projects/{project_id}/persistent_data_stores/{name}": { "delete": { "description": "Delete a persistent data store.", "operationId": "delete_persistent_data_store", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a persistent data store", "tags": [ "Persistent data stores" ], "x-ibm-events": { "events": [ { "name": "codeengine.persistentdatastore.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/persistent_data_stores/my-persistent-data-store?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deletePersistentDataStoreOptions := codeEngineService.NewDeletePersistentDataStoreOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-persistent-data-store\",\n", ")\n", "\n", "response, err := codeEngineService.DeletePersistentDataStore(deletePersistentDataStoreOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeletePersistentDataStore(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeletePersistentDataStoreOptions deletePersistentDataStoreOptions = new DeletePersistentDataStoreOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-persistent-data-store\")\n", " .build();\n", "\n", "Response response = codeEngineService.deletePersistentDataStore(deletePersistentDataStoreOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-persistent-data-store',\n", "};\n", "\n", "try {\n", " await codeEngineService.deletePersistentDataStore(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_persistent_data_store(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-persistent-data-store',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Get a persistent data store.", "operationId": "get_persistent_data_store", "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2025-05-15T22:07:55+01:00", "data": { "bucket_location": "us-east", "bucket_name": "my-bucket", "secret_name": "my-secret" }, "entity_tag": "2385407409", "id": "3bf57be1-66f0-4a89-ad34-ed77c049935e", "name": "my-persistent-data-store", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "persistent_data_store_v2", "storage_type": "object_storage" }, "schema": { "$ref": "#/components/schemas/PersistentDataStore" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the persistent data store", "schema": { "description": "version of the persistent data store", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a persistent data store", "tags": [ "Persistent data stores" ], "x-ibm-events": { "events": [ { "name": "codeengine.persistentdatastore.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/persistent_data_stores/my-persistent-data-store?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getPersistentDataStoreOptions := codeEngineService.NewGetPersistentDataStoreOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-persistent-data-store\",\n", ")\n", "\n", "persistentDataStore, response, err := codeEngineService.GetPersistentDataStore(getPersistentDataStoreOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(persistentDataStore, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetPersistentDataStoreOptions getPersistentDataStoreOptions = new GetPersistentDataStoreOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-persistent-data-store\")\n", " .build();\n", "\n", "Response response = codeEngineService.getPersistentDataStore(getPersistentDataStoreOptions).execute();\n", "PersistentDataStore persistentDataStore = response.getResult();\n", "\n", "System.out.println(persistentDataStore);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-persistent-data-store',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getPersistentDataStore(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_persistent_data_store(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-persistent-data-store',\n", ")\n", "persistent_data_store = response.get_result()\n", "\n", "print(json.dumps(persistent_data_store, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your persistent data store.", "example": "my-persistent-data-store", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ] }, "/projects/{project_id}/secrets": { "get": { "description": "List all secrets in a project.", "operationId": "list_secrets", "parameters": [ { "description": "Secret format to filter results by.", "example": "ssh_auth", "in": "query", "name": "format", "schema": { "enum": [ "generic", "ssh_auth", "registry", "basic_auth", "hmac_auth", "tls", "service_access", "service_operator" ], "type": "string" } }, { "description": "Optional maximum number of secrets per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "limit": 50, "secrets": [ { "created_at": "2022-11-15T21:59:08+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386255530", "format": "generic", "generated_by": "user", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret", "id": "36e3a621-4895-4bd1-b7e8-1163ab49a28f", "name": "my-secret", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "secret_generic_v2" } ] }, "schema": { "$ref": "#/components/schemas/SecretList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List secrets", "tags": [ "Secrets and configmaps" ], "x-ibm-events": { "events": [ { "name": "codeengine.secret.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" }, { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "listSecretsOptions := &codeenginev2.ListSecretsOptions{\n", " ProjectID: core.StringPtr(\"15314cc3-85b4-4338-903f-c28cdee6d005\"),\n", " Format: core.StringPtr(\"ssh_auth\"),\n", " Limit: core.Int64Ptr(int64(100)),\n", "}\n", "\n", "pager, err := codeEngineService.NewSecretsPager(listSecretsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "\n", "var allResults []codeenginev2.Secret\n", "for pager.HasNext() {\n", " nextPage, err := pager.GetNext()\n", " if err != nil {\n", " panic(err)\n", " }\n", " allResults = append(allResults, nextPage...)\n", "}\n", "b, _ := json.MarshalIndent(allResults, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ListSecretsOptions listSecretsOptions = new ListSecretsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .format(\"ssh_auth\")\n", " .limit(Long.valueOf(\"100\"))\n", " .build();\n", "\n", "SecretsPager pager = new SecretsPager(codeEngineService, listSecretsOptions);\n", "List allResults = new ArrayList<>();\n", "while (pager.hasNext()) {\n", " List nextPage = pager.getNext();\n", " allResults.addAll(nextPage);\n", "}\n", "\n", "System.out.println(GsonSingleton.getGson().toJson(allResults));\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " format: 'ssh_auth',\n", " limit: 100,\n", "};\n", "\n", "const allResults = [];\n", "try {\n", " const pager = new CodeEngineV2.SecretsPager(codeEngineService, params);\n", " while (pager.hasNext()) {\n", " const nextPage = await pager.getNext();\n", " expect(nextPage).not.toBeNull();\n", " allResults.push(...nextPage);\n", " }\n", " console.log(JSON.stringify(allResults, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "all_results = []\n", "pager = SecretsPager(\n", " client=code_engine_service,\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " format='ssh_auth',\n", " limit=100,\n", ")\n", "while pager.has_next():\n", " next_page = pager.get_next()\n", " assert next_page is not None\n", " all_results.extend(next_page)\n", "\n", "print(json.dumps(all_results, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "post": { "description": "Create a secret.", "operationId": "create_secret", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretPrototype" } } }, "description": "Secret prototype.", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "created_at": "2022-11-15T21:59:08+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386255530", "format": "generic", "generated_by": "user", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret", "id": "36e3a621-4895-4bd1-b7e8-1163ab49a28f", "name": "my-secret", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "secret_generic_v2" }, "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "Created", "headers": { "ETag": { "description": "version of the secret", "schema": { "description": "version of the secret", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a secret", "tags": [ "Secrets and configmaps" ], "x-codegen-request-body-name": "secret", "x-ibm-events": { "events": [ { "name": "codeengine.secret.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"my-secret\",\n \"format\": \"generic\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "createSecretOptions := codeEngineService.NewCreateSecretOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"generic\",\n", " \"my-secret\",\n", ")\n", "\n", "secret, response, err := codeEngineService.CreateSecret(createSecretOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secret, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "CreateSecretOptions createSecretOptions = new CreateSecretOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .format(\"generic\")\n", " .name(\"my-secret\")\n", " .build();\n", "\n", "Response response = codeEngineService.createSecret(createSecretOptions).execute();\n", "Secret secret = response.getResult();\n", "\n", "System.out.println(secret);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " format: 'generic',\n", " name: 'my-secret',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.createSecret(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.create_secret(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " format='generic',\n", " name='my-secret',\n", ")\n", "result = response.get_result()\n", "\n", "fields = ['name', 'resource_type', 'format', 'entity_tag', 'generated_by', 'created_at']\n", "print(json.dumps({k: result[k] for k in fields if k in result}, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/secrets/{name}": { "delete": { "description": "Delete a secret.", "operationId": "delete_secret", "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a secret", "tags": [ "Secrets and configmaps" ], "x-ibm-events": { "events": [ { "name": "codeengine.secret.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "deleteSecretOptions := codeEngineService.NewDeleteSecretOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-secret\",\n", ")\n", "\n", "response, err := codeEngineService.DeleteSecret(deleteSecretOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteSecret(): %d\\n\", response.StatusCode)\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "DeleteSecretOptions deleteSecretOptions = new DeleteSecretOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-secret\")\n", " .build();\n", "\n", "Response response = codeEngineService.deleteSecret(deleteSecretOptions).execute();\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-secret',\n", "};\n", "\n", "try {\n", " await codeEngineService.deleteSecret(params);\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.delete_secret(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-secret',\n", ")\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Get a secret.", "operationId": "get_secret", "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2022-11-15T21:59:08+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386255530", "format": "generic", "generated_by": "user", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret", "id": "36e3a621-4895-4bd1-b7e8-1163ab49a28f", "name": "my-secret", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "secret_generic_v2" }, "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the secret", "schema": { "description": "version of the secret", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a secret", "tags": [ "Secrets and configmaps" ], "x-ibm-events": { "events": [ { "name": "codeengine.secret.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" }, { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getSecretOptions := codeEngineService.NewGetSecretOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-secret\",\n", ")\n", "\n", "secret, response, err := codeEngineService.GetSecret(getSecretOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secret, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetSecretOptions getSecretOptions = new GetSecretOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-secret\")\n", " .build();\n", "\n", "Response response = codeEngineService.getSecret(getSecretOptions).execute();\n", "Secret secret = response.getResult();\n", "\n", "System.out.println(secret);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-secret',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getSecret(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_secret(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-secret',\n", ")\n", "result = response.get_result()\n", "\n", "fields = ['name', 'resource_type', 'format', 'entity_tag', 'generated_by', 'created_at']\n", "print(json.dumps({k: result[k] for k in fields if k in result}, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The name of your secret.", "example": "my-secret", "in": "path", "name": "name", "required": true, "schema": { "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([\\-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([\\-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "put": { "description": "Update a secret.", "operationId": "replace_secret", "parameters": [ { "description": "Version of the secret settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when reading the secret. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.", "in": "header", "name": "If-Match", "required": true, "schema": { "maxLength": 256, "minLength": 1, "pattern": "^[0-9]*$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretPatch" } } }, "description": "Secret patch.", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2022-11-15T21:59:08+01:00", "data": { "MY_PROPERTY": "VALUE" }, "entity_tag": "2386255530", "format": "generic", "generated_by": "user", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret", "id": "36e3a621-4895-4bd1-b7e8-1163ab49a28f", "name": "my-secret", "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "us-east", "resource_type": "secret_generic_v2" }, "schema": { "$ref": "#/components/schemas/Secret" } } }, "description": "OK", "headers": { "ETag": { "description": "version of the secret", "schema": { "description": "version of the secret", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Update a secret", "tags": [ "Secrets and configmaps" ], "x-codegen-request-body-name": "secret", "x-ibm-events": { "events": [ { "name": "codeengine.secret.read" }, { "name": "codeengine.secret.update" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request PUT\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/secrets/my-secret?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"format\": \"generic\"\n}'" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "replaceSecretOptions := codeEngineService.NewReplaceSecretOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", " \"my-secret\",\n", " \"testString\",\n", " \"generic\",\n", ")\n", "\n", "secret, response, err := codeEngineService.ReplaceSecret(replaceSecretOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(secret, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "ReplaceSecretOptions replaceSecretOptions = new ReplaceSecretOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .name(\"my-secret\")\n", " .ifMatch(\"testString\")\n", " .format(\"generic\")\n", " .build();\n", "\n", "Response response = codeEngineService.replaceSecret(replaceSecretOptions).execute();\n", "Secret secret = response.getResult();\n", "\n", "System.out.println(secret);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name: 'my-secret',\n", " ifMatch: 'testString',\n", " format: 'generic',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.replaceSecret(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.replace_secret(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", " name='my-secret',\n", " if_match='testString',\n", " format='generic',\n", ")\n", "result = response.get_result()\n", "\n", "fields = ['name', 'resource_type', 'format', 'entity_tag', 'generated_by', 'created_at']\n", "print(json.dumps({k: result[k] for k in fields if k in result}, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/status_details": { "get": { "description": "Retrieves status details about the given project.", "operationId": "get_project_status_details", "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "$ref": "#/components/parameters/version" } ], "responses": { "200": { "content": { "application/json": { "example": { "cbr": { "data_plane": { "enforcement": "applied", "inbound_private": "allowed", "inbound_public": "allowed", "last_synced_at": "2025-06-30T11:41:35Z" } }, "domain": "ready", "project": "enabled", "vpe": "ready" }, "schema": { "$ref": "#/components/schemas/ProjectStatusDetails" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get the status details for a project", "tags": [ "Projects" ], "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/status_details?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ], "go": [ { "example": [ { "lang": "go", "source": [ "getProjectStatusDetailsOptions := codeEngineService.NewGetProjectStatusDetailsOptions(\n", " \"15314cc3-85b4-4338-903f-c28cdee6d005\",\n", ")\n", "\n", "projectStatusDetails, response, err := codeEngineService.GetProjectStatusDetails(getProjectStatusDetailsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(projectStatusDetails, \"\", \" \")\n", "fmt.Println(string(b))\n" ], "type": "code" } ], "name": "Example request" } ], "java": [ { "example": [ { "lang": "java", "source": [ "GetProjectStatusDetailsOptions getProjectStatusDetailsOptions = new GetProjectStatusDetailsOptions.Builder()\n", " .projectId(\"15314cc3-85b4-4338-903f-c28cdee6d005\")\n", " .build();\n", "\n", "Response response = codeEngineService.getProjectStatusDetails(getProjectStatusDetailsOptions).execute();\n", "ProjectStatusDetails projectStatusDetails = response.getResult();\n", "\n", "System.out.println(projectStatusDetails);\n" ], "type": "code" } ], "name": "Example request" } ], "node": [ { "example": [ { "lang": "node", "source": [ "const params = {\n", " projectId: '15314cc3-85b4-4338-903f-c28cdee6d005',\n", "};\n", "\n", "let res;\n", "try {\n", " res = await codeEngineService.getProjectStatusDetails(params);\n", " console.log(JSON.stringify(res.result, null, 2));\n", "} catch (err) {\n", " console.warn(err);\n", "}\n" ], "type": "code" } ], "name": "Example request" } ], "python": [ { "example": [ { "lang": "python", "source": [ "response = code_engine_service.get_project_status_details(\n", " project_id='15314cc3-85b4-4338-903f-c28cdee6d005',\n", ")\n", "project_status_details = response.get_result()\n", "\n", "print(json.dumps(project_status_details, indent=2))\n" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/subnet_pools": { "get": { "description": "List all subnet pools in a project.", "operationId": "list_subnet_pools", "parameters": [ { "description": "Optional maximum number of subnet pools per page.", "example": 100, "in": "query", "name": "limit", "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation response.", "in": "query", "name": "start", "schema": { "maxLength": 65536, "minLength": 0, "pattern": "^[a-zA-Z0-9=]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "first": { "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools?limit=50" }, "limit": 50, "subnet_pools": [ { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools/b5e300ed-50c9-4775-b29c-03f6a67ac41f", "id": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "name": "subnet-pool-eu-de-1", "pool": [ { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "subnet_pool_v2" } ] }, "schema": { "$ref": "#/components/schemas/SubnetPoolList" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "List subnet pools", "tags": [ "Subnet pools" ], "x-ibm-events": { "events": [ { "name": "codeengine.subnetpool.list" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ], "post": { "description": "Create a subnet pool.", "operationId": "create_subnet_pool", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubnetPoolPrototype" } } }, "description": "Subnet pool prototype.", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools/b5e300ed-50c9-4775-b29c-03f6a67ac41f", "id": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "name": "subnet-pool-eu-de-1", "pool": [ { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "subnet_pool_v2" }, "schema": { "$ref": "#/components/schemas/SubnetPool" } } }, "description": "Created" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Create a subnet pool", "tags": [ "Subnet pools" ], "x-codegen-request-body-name": "subnetpool", "x-ibm-events": { "events": [ { "name": "codeengine.subnetpool.create" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request POST\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n \"name\": \"subnet-pool-eu-de-1\",\n \"pool\": [\n {\n \"security_group_crns\": [\n \"crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271\"\n ],\n \"subnet_crn\": \"crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56\"\n }\n ]\n}'" ], "type": "code" } ], "name": "Example request" } ] } } } }, "/projects/{project_id}/subnet_pools/{id}": { "delete": { "description": "Delete a subnet pool.", "operationId": "delete_subnet_pool", "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a subnet pool", "tags": [ "Subnet pools" ], "x-ibm-events": { "events": [ { "name": "codeengine.subnetpool.delete" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request DELETE\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools/d0cb584c-8d17-4709-a2b3-769ccd90ced9?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } }, "get": { "description": "Get a subnet pool.", "operationId": "get_subnet_pool", "responses": { "200": { "content": { "application/json": { "example": { "created_at": "2026-01-10T07:49:35Z", "href": "https://api.us-east.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools/b5e300ed-50c9-4775-b29c-03f6a67ac41f", "id": "b5e300ed-50c9-4775-b29c-03f6a67ac41f", "name": "subnet-pool-eu-de-1", "pool": [ { "security_group_crns": [ "crn:v1:bluemix:public:is:eu-de:a/dc5e6392e5d14021846031b83e95f190::security-group:r026-be5df5ca-12a0-494b-907e-aa6ec2bfa271" ], "subnet_crn": "crn:v1:bluemix:public:is:eu-de-1:a/dc5e6392e5d14021846031b83e95f190::subnet:02c7-e16ae723-36bc-41eb-992d-f4667a4abc56" } ], "project_id": "15314cc3-85b4-4338-903f-c28cdee6d005", "region": "eu-de", "resource_type": "subnet_pool_v2" }, "schema": { "$ref": "#/components/schemas/SubnetPool" } } }, "description": "OK" }, "400": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "errors": [ { "code": "unauthorized", "message": "A meaningful explanation" } ], "status_code": 503, "trace": "codeengine-api-93ca4d5e39454d04b878ddb6b9bb82c4" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "Bearer": [] } ], "summary": "Get a subnet pool", "tags": [ "Subnet pools" ], "x-ibm-events": { "events": [ { "name": "codeengine.subnetpool.read" } ] }, "x-ibm-permissions": { "actions": [ { "name": "codeengine.tenant.entities.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "example": [ { "lang": "curl", "source": [ "curl --request GET\\\n", " \"https://api.${region}.codeengine.cloud.ibm.com/v2/projects/15314cc3-85b4-4338-903f-c28cdee6d005/subnet_pools/d0cb584c-8d17-4709-a2b3-769ccd90ced9?version=2025-07-10\"\\\n", " --header \"Authorization: Bearer ${token}\" \n" ], "type": "code" } ], "name": "Example request" } ] } } }, "parameters": [ { "description": "The ID of the project.", "example": "15314cc3-85b4-4338-903f-c28cdee6d005", "in": "path", "name": "project_id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } }, { "description": "The ID of the subnet pool.", "example": "d0cb584c-8d17-4709-a2b3-769ccd90ced9", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "type": "string" } } ] } }, "servers": [ { "description": "Endpoint for region Sydney.", "url": "https://api.au-syd.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Sao Paolo.", "url": "https://api.br-sao.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Toronto.", "url": "https://api.ca-tor.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Frankfurt.", "url": "https://api.eu-de.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region London.", "url": "https://api.eu-gb.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Osaka.", "url": "https://api.jp-osa.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Tokyo.", "url": "https://api.jp-tok.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Washington.", "url": "https://api.us-east.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Dallas.", "url": "https://api.us-south.codeengine.cloud.ibm.com/v2" }, { "description": "Endpoint for region Madrid.", "url": "https://api.eu-es.codeengine.cloud.ibm.com/v2" } ], "tags": [ { "description": "Project related operations.", "name": "Projects" }, { "description": "Application related operations.", "name": "Applications" }, { "description": "Job related operations.", "name": "Jobs" }, { "description": "Function related operations.", "name": "Functions" }, { "description": "Service Binding related operations.", "name": "Service bindings" }, { "description": "Build related operations.", "name": "Image builds" }, { "description": "Domain Mapping related operations.", "name": "Domain mappings" }, { "description": "Config map and secret related operations.", "name": "Secrets and configmaps" }, { "description": "Persistent Data Store related operations.", "name": "Persistent data stores" }, { "description": "Fleet related operations.", "name": "Fleets" }, { "description": "Subnet pool related operations.", "name": "Subnet pools" }, { "description": "Project settings related operations.", "name": "Project settings" } ] }