List the function runtimes

GET /function_runtimes

List all valid function runtimes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Request

Response

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List all projects

GET /projects

List all projects in the current account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

resource-controller.instance.retrieve

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of projects per page.

start

string

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.

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

integer

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

403 - Forbidden

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

500 - Internal Server Error

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a project

POST /projects

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.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

resource-controller.instance.create

Auditing

Calling this method generates the following auditing event.

resource-controller.instance.create

Request

Request Body

ProjectPrototype

Project prototype

name

Required *

string

The name of the project.

resource_group_id

string

Optional ID of the resource group for your project deployment. If this field is not defined, the default resource group of the account will be used.

Response

Lowercase UUID uniquely identifying the request

Delete a project

DELETE /projects/{id}

Delete a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

resource-controller.instance.delete

Auditing

Calling this method generates the following auditing event.

resource-controller.instance.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a project

GET /projects/{id}

Display the details of a single project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

resource-controller.instance.retrieve

Request

Response

Lowercase UUID uniquely identifying the request

List allowed outbound destinations

GET /projects/{project_id}/allowed_outbound_destinations

List all allowed outbound destinations in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.allowedoutbounddestination.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of allowed outbound destinations per page.

start

string

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.

Response

200 - OK

allowed_outbound_destinations

array

List of all allowed outbound destinations.

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create an allowed outbound destination

POST /projects/{project_id}/allowed_outbound_destinations

Create an allowed outbound destination.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.update

Auditing

Calling this method generates the following auditing event.

codeengine.allowedoutbounddestination.create

Request

Request Body

AllowedOutboundDestinationPrototype

AllowedOutboundDestination prototype

name

Required *

string

The name of the allowed outbound destination.

string

The name of the allowed outbound destination.

project_id

string

The ID of the project in which the resource is located.

status

string

The current status of the outbound destination.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Delete an allowed outbound destination

DELETE /projects/{project_id}/allowed_outbound_destinations/{name}

Delete an allowed outbound destination.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.update

Auditing

Calling this method generates the following auditing event.

codeengine.allowedoutbounddestination.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get an allowed outbound destination

GET /projects/{project_id}/allowed_outbound_destinations/{name}

Display the details of an allowed outbound destination.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.allowedoutbounddestination.read

Request

Response

200 - OK

entity_tag

string

The version of the allowed outbound destination, which is used to achieve optimistic locking.

name

string

The name of the allowed outbound destination.

project_id

string

The ID of the project in which the resource is located.

status

string

The current status of the outbound destination.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Update an allowed outbound destination

PATCH /projects/{project_id}/allowed_outbound_destinations/{name}

Update an allowed outbound destination.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.update

Auditing

Calling this method generates the following auditing event.

codeengine.allowedoutbounddestination.read
codeengine.allowedoutbounddestination.update

Request

Request Body

AllowedOutboundDestination patch

Path Parameters

Query Parameters

Response

200 - OK

entity_tag

string

The version of the allowed outbound destination, which is used to achieve optimistic locking.

name

string

The name of the allowed outbound destination.

project_id

string

The ID of the project in which the resource is located.

status

string

The current status of the outbound destination.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List applications

GET /projects/{project_id}/apps

List all applications in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.application.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of apps per page.

start

string

Response

200 - OK

apps

array

List of all apps.

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create an application

POST /projects/{project_id}/apps

Create an application.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.application.create

Request

Request Body

AppPrototype

App prototype

image_port

integer

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.

image_reference

Required *

string

The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY` and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the default is `latest`. If the image reference points to a registry that requires authentication, make sure to also specify the property `image_secret`.

image_secret

string

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. If 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.

managed_domain_mappings

string

Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

name

scale_min_instances

integer

Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if not hit by any request for some time.

scale_request_timeout

integer

Optional amount of time in seconds that is allowed for a running app to respond to a request.

Response

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.

image_reference

string

image_secret

string

string

The type of the app.

run_arguments

array

run_as_user

integer

Optional user ID (UID) to run the app.

integer

scale_cpu_limit

string

Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

scale_down_delay

integer

Optional amount of time in seconds that delays the scale-down behavior for an app instance.

scale_ephemeral_storage_limit

string

scale_initial_instances

integer

Optional initial number of instances that are created upon app creation or app update.

scale_max_instances

integer

scale_memory_limit

string

scale_min_instances

Lowercase UUID uniquely identifying the request

List application instances

GET /projects/{project_id}/apps/{app_name}/instances

List all instances of an application.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.application.list

Request

Path Parameters

project_id

Required *

string

The ID of the project.

app_name

Required *

string

The name of your application.

Query Parameters

limit

integer

Optional maximum number of apps per page.

start

string

version

string

The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between `2021-03-31` and `2026-11-03`.

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

instances

array

List of all app instances.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List application revisions

GET /projects/{project_id}/apps/{app_name}/revisions

List all application revisions in a particular application.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.application.list

Request

Path Parameters

project_id

Required *

string

The ID of the project.

app_name

Required *

string

The name of your application.

Query Parameters

limit

integer

Optional maximum number of apps per page.

start

string

version

string

The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between `2021-03-31` and `2026-11-03`.

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

integer

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

403 - Forbidden

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

500 - Internal Server Error

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Delete an application revision

DELETE /projects/{project_id}/apps/{app_name}/revisions/{name}

Delete an application revision.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.application.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get an application revision

GET /projects/{project_id}/apps/{app_name}/revisions/{name}

Display the details of an application revision.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.application.read

Request

Response

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.

image_reference

string

string

The type of the app revision.

run_arguments

array

run_as_user

integer

Optional user ID (UID) to run the app.

integer

scale_cpu_limit

string

Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

scale_down_delay

integer

Optional amount of time in seconds that delays the scale-down behavior for an app instance.

scale_ephemeral_storage_limit

string

scale_initial_instances

integer

Optional initial number of instances that are created upon app creation or app update.

scale_max_instances

integer

scale_memory_limit

string

scale_min_instances

Lowercase UUID uniquely identifying the request

Delete an application

DELETE /projects/{project_id}/apps/{name}

Delete an application.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.application.read
codeengine.application.delete

Request

Path Parameters

Query Parameters

keep_service_access

boolean

Determines if connected service access secrets remain intact after app deletion.

Response

Lowercase UUID uniquely identifying the request

Get an application

GET /projects/{project_id}/apps/{name}

Display the details of an application.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.application.read

Request

Response

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.

image_reference

string

image_secret

string

string

The type of the app.

run_arguments

array

run_as_user

integer

Optional user ID (UID) to run the app.

integer

scale_cpu_limit

string

Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

scale_down_delay

integer

Optional amount of time in seconds that delays the scale-down behavior for an app instance.

scale_ephemeral_storage_limit

string

scale_initial_instances

integer

Optional initial number of instances that are created upon app creation or app update.

scale_max_instances

integer

scale_memory_limit

string

scale_min_instances

Lowercase UUID uniquely identifying the request

Update an application

PATCH /projects/{project_id}/apps/{name}

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

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.application.read
codeengine.application.list
codeengine.application.update

Request

Request Body

App patch

Path Parameters

Query Parameters

Response

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.

image_reference

string

image_secret

string

string

The type of the app.

run_arguments

array

run_as_user

integer

Optional user ID (UID) to run the app.

integer

scale_cpu_limit

string

Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

scale_down_delay

integer

Optional amount of time in seconds that delays the scale-down behavior for an app instance.

scale_ephemeral_storage_limit

string

scale_initial_instances

integer

Optional initial number of instances that are created upon app creation or app update.

scale_max_instances

integer

scale_memory_limit

string

scale_min_instances

Lowercase UUID uniquely identifying the request

List bindings

GET /projects/{project_id}/bindings

List all bindings in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.secret.list
codeengine.application.list
codeengine.job.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of bindings per page.

start

string

Response

200 - OK

bindings

array

List of all bindings.

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a binding

POST /projects/{project_id}/bindings

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

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create
codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.secret.create
codeengine.secret.read
codeengine.secret.update
codeengine.application.list
codeengine.application.update
codeengine.job.list
codeengine.job.update

Response

Lowercase UUID uniquely identifying the request

Delete a binding

DELETE /projects/{project_id}/bindings/{id}

Delete a binding.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete
codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.secret.list
codeengine.secret.update
codeengine.application.list
codeengine.application.update
codeengine.job.list
codeengine.job.update

Request

Response

Lowercase UUID uniquely identifying the request

Get a binding

GET /projects/{project_id}/bindings/{id}

Display the details of a binding.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.secret.list

Request

Response

Lowercase UUID uniquely identifying the request

List build runs

GET /projects/{project_id}/build_runs

List all build runs in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.buildrun.list

Request

Path Parameters

Query Parameters

build_name

string

Optional name of the build that should be filtered for.

limit

integer

Optional maximum number of build runs per page.

start

string

Response

200 - OK

build_runs

array

List of all build runs.

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a build run

POST /projects/{project_id}/build_runs

Create a build run.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.buildrun.create

Name of the secret that is used access the repository source. This 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. If the `source_type` value is `local`, this field must be omitted.

source_type

string

Specifies the type of source to determine if your build source is in a repository or based on local source code.

local - For builds from local source code.
git - For builds from git version controlled source code.

source_url

string

The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like `https://github.com/IBM/CodeEngine`. If 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`.

strategy_size

string

Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`, `xxlarge`.

strategy_spec_file

string

Optional path to the specification file that is used for build strategies for building an image.

strategy_type

string

The strategy to use for building the image.

timeout

integer

The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

Response

source_context_dir

string

string

The current status of the build run.

status_details

BuildRunStatus

Current status condition of a build run.

strategy_size

Lowercase UUID uniquely identifying the request

Delete a build run

DELETE /projects/{project_id}/build_runs/{name}

Delete a build run.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.buildrun.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a build run

GET /projects/{project_id}/build_runs/{name}

Display the details of a build run.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.buildrun.read

Request

Response

source_context_dir

string

string

The current status of the build run.

status_details

BuildRunStatus

Current status condition of a build run.

strategy_size

Lowercase UUID uniquely identifying the request

List builds

GET /projects/{project_id}/builds

List all builds in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.build.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of builds per page.

start

string

Response

200 - OK

builds

array

List of all builds.

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a build

POST /projects/{project_id}/builds

Create a build.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.build.create

Request

Request Body

BuildPrototype

Build prototype

name

Required *

string

The name of the build. Use a name that is unique within the project.

output_image

Required *

string

The name of the image.

output_secret

Required *

string

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.

run_build_params

array

Optional references to config maps and secret keys, or literal values that are exposed as build arguments within the Docker file.

source_context_dir

string

string

Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`, `large`, `xlarge`, `xxlarge`.

strategy_spec_file

string

Optional path to the specification file that is used for build strategies for building an image.

strategy_type

Required *

string

The strategy to use for building the image.

timeout

integer

The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

Response

string

The current status of the build.

status_details

BuildStatus

The detailed status of the build.

strategy_size

Lowercase UUID uniquely identifying the request

Delete a build

DELETE /projects/{project_id}/builds/{name}

Delete a build.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.build.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a build

GET /projects/{project_id}/builds/{name}

Display the details of a build.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.build.read

Request

Response

string

The current status of the build.

status_details

BuildStatus

The detailed status of the build.

strategy_size

Lowercase UUID uniquely identifying the request

Update a build

PATCH /projects/{project_id}/builds/{name}

Update a build.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.build.read
codeengine.build.update

Request

Request Body

Build patch

Path Parameters

Query Parameters

Response

string

The current status of the build.

status_details

BuildStatus

The detailed status of the build.

strategy_size

Lowercase UUID uniquely identifying the request

List config maps

GET /projects/{project_id}/config_maps

List all config maps in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.configmap.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of config maps per page.

start

string

Response

200 - OK

config_maps

array

List of all config maps.

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a config map

POST /projects/{project_id}/config_maps

Create a config map.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.configmap.create

Request

Request Body

ConfigMapPrototype

Config map prototype.

data

object

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.

name

Required *

string

The name of the configmap. Use a name that is unique within the project.

Response

Lowercase UUID uniquely identifying the request

Delete a config map

DELETE /projects/{project_id}/config_maps/{name}

Delete a config map.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.configmap.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a config map

GET /projects/{project_id}/config_maps/{name}

Display the details of a config map.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.configmap.read

Request

Response

Lowercase UUID uniquely identifying the request

Update a config map

PUT /projects/{project_id}/config_maps/{name}

Update a config map.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.configmap.read
codeengine.configmap.update

Request

Request Body

ConfigMapPatch

Config map prototype.

data

object

Path Parameters

Query Parameters

Response

Lowercase UUID uniquely identifying the request

List domain mappings

GET /projects/{project_id}/domain_mappings

List all domain mappings in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.domainmapping.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of domain mappings per page.

start

string

Response

200 - OK

domain_mappings

array

List of all domain mappings.

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a domain mapping

POST /projects/{project_id}/domain_mappings

Create a domain mapping

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.domainmapping.create

Response

Lowercase UUID uniquely identifying the request

Delete a domain mapping

DELETE /projects/{project_id}/domain_mappings/{name}

Delete a domain mapping

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.domainmapping.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a domain mapping

GET /projects/{project_id}/domain_mappings/{name}

Get domain mapping

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.domainmapping.read

Request

Response

Lowercase UUID uniquely identifying the request

Update a domain mapping

PATCH /projects/{project_id}/domain_mappings/{name}

Update a domain mapping

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.domainmapping.read
codeengine.domainmapping.update

Request

Request Body

DomainMapping patch

Path Parameters

Query Parameters

Response

Lowercase UUID uniquely identifying the request

List egress IP addresses

GET /projects/{project_id}/egress_ips

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.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Request

Path Parameters

project_id

Required *

string

The ID of the project.

Query Parameters

version

string

The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between `2021-03-31` and `2026-11-03`.

Response

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List fleets

GET /projects/{project_id}/fleets

List all fleets in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.fleet.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of fleets per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

fleets

array

List of fleets.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a fleet

POST /projects/{project_id}/fleets

Create a fleet.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.fleet.create

Request

Request Body

FleetPrototype

Fleet prototype.

image_reference

Required *

string

The name of the image that is used for this fleet.

image_secret

string

name

Required *

string

The name of the fleet.

network_placements

Required *

scale_down_delay

string

Optional amount of time that delays worker scale-down after task completion.

scale_gpu

GPUScalePrototype

Optional information around allocation of GPUs to process tasks.

preferences

array

List of GPU preferences in descending order.

scale_max_execution_time

string

Optional maximum execution time of each attempt to process a task instance.

scale_max_instances

Required *

integer

Optional maximum number of instances for this fleet, determining how many task are processed simultaneously.

scale_memory_limit

Required *

Required *

TaskStateStorePrototype

The reference to the object store where the task progress is maintained.

persistent_data_store

Required *

string

Name of referenced persistent data store resource.

sub_path

string

Optional object storage prefix to be used as an entry point.

Response

string

The current status of the fleet.

status_details

FleetStatusDetails

The detailed status of the fleet.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List tasks

GET /projects/{project_id}/fleets/{fleet_id}/tasks

List tasks.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.task.list

Request

Path Parameters

project_id

Required *

string

The ID of the project.

fleet_id

Required *

string

The ID of the fleet.

Query Parameters

status

string

Status condition to filter the tasks by

limit

integer

Optional maximum number of subnet pools per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Get a task

GET /projects/{project_id}/fleets/{fleet_id}/tasks/{id}

Get a task.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.task.read

Request

The ID of the task.

Query Parameters

Response

Lowercase UUID uniquely identifying the request

List workers

GET /projects/{project_id}/fleets/{fleet_id}/workers

List workers.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.worker.list

Request

Path Parameters

project_id

Required *

string

The ID of the project.

fleet_id

Required *

string

The ID of the fleet.

Query Parameters

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Get a worker

GET /projects/{project_id}/fleets/{fleet_id}/workers/{name}

Get a worker.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.worker.read

Request

The name of the worker.

Query Parameters

Response

Lowercase UUID uniquely identifying the request

Delete a fleet

DELETE /projects/{project_id}/fleets/{id}

Delete a fleet.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.fleet.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a fleet

GET /projects/{project_id}/fleets/{id}

Get a fleet.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.fleet.read

Request

Response

string

The current status of the fleet.

status_details

FleetStatusDetails

The detailed status of the fleet.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Add tasks to a fleet

POST /projects/{project_id}/fleets/{id}/add_tasks

Add tasks to a fleet.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.fleet.action.addtasks.create

Request

Request Body

FleetAddTasksPrototype

Add tasks request.

batch_name

string

Optional name for the batch of tasks being added.

tasks_specification

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Cancel a fleet

POST /projects/{project_id}/fleets/{id}/cancel

Cancel a fleet.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.fleet.update

Request

Request Body

FleetCancel

Fleet cancel request.

cancel_processing_tasks

boolean

Property determining if the fleet cancelation should immediately abort already running tasks, if so, set to `true`.

Path Parameters

project_id

Required *

string

The ID of the project.

id

Required *

string

The ID of the fleet.

Query Parameters

Response

string

The current status of the fleet.

status_details

FleetStatusDetails

The detailed status of the fleet.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List functions

GET /projects/{project_id}/functions

List all functions in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.function.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of functions per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

functions

array

List of all functions.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a function

POST /projects/{project_id}/functions

Create a function.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.function.create

201 - Created

code_binary

boolean

Specifies whether the code is binary or not. Defaults to false when `code_reference` is set to a data URL. When `code_reference` is set to a code bundle URL, this field is always true.

code_main

string

Specifies the name of the function that should be invoked.

string

The identifier of the resource.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.function.delete

Request

Path Parameters

Query Parameters

keep_service_access

boolean

Determines if connected service access secrets remain intact after function deletion.

Response

Lowercase UUID uniquely identifying the request

Get a function

GET /projects/{project_id}/functions/{name}

Display the details of a function.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.function.read

Request

Response

200 - OK

code_binary

boolean

Specifies whether the code is binary or not. Defaults to false when `code_reference` is set to a data URL. When `code_reference` is set to a code bundle URL, this field is always true.

code_main

string

Specifies the name of the function that should be invoked.

string

The identifier of the resource.

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Update a function

PATCH /projects/{project_id}/functions/{name}

Update the given function.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.function.read
codeengine.function.update

Request

Request Body

Function patch

Path Parameters

Query Parameters

Response

200 - OK

code_binary

boolean

Specifies whether the code is binary or not. Defaults to false when `code_reference` is set to a data URL. When `code_reference` is set to a code bundle URL, this field is always true.

code_main

string

Specifies the name of the function that should be invoked.

string

The identifier of the resource.

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List job runs

GET /projects/{project_id}/job_runs

List all job runs in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.jobrun.list

Request

Path Parameters

Query Parameters

job_name

string

Optional name of the job that you want to use to filter.

limit

integer

Optional maximum number of job runs per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

job_runs

array

List of all jobs.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a job run

POST /projects/{project_id}/job_runs

Create an job run.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.jobrun.create

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`.

Response

202 - Accepted

computed_env_variables

array

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.

created_at

string

The timestamp when the resource was created.

href

string

When you provision a new job run, a URL is created identifying the location of the instance.

id

string

The identifier of the resource.

image_reference

string

array

run_as_user

integer

The user ID (UID) to run the job.

run_commands

array

run_compute_resource_token_enabled

boolean

Optional flag to enable the use of a compute resource token mounted to the container file system.

run_env_variables

array

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.

run_mode

string

run_service_account

string

run_volume_mounts

array

Delete a job run

DELETE /projects/{project_id}/job_runs/{name}

Delete a job run.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.jobrun.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a job run

GET /projects/{project_id}/job_runs/{name}

Display the details of a job run.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.jobrun.read

Request

Response

200 - OK

computed_env_variables

array

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.

created_at

string

The timestamp when the resource was created.

href

string

When you provision a new job run, a URL is created identifying the location of the instance.

id

string

The identifier of the resource.

image_reference

string

array

run_as_user

integer

The user ID (UID) to run the job.

run_commands

array

run_compute_resource_token_enabled

boolean

Optional flag to enable the use of a compute resource token mounted to the container file system.

run_env_variables

array

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.

run_mode

string

run_service_account

string

run_volume_mounts

array

List jobs

GET /projects/{project_id}/jobs

List all jobs in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.job.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of jobs per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

jobs

array

List of all jobs.

limit

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a job

POST /projects/{project_id}/jobs

Create a job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.job.create

Request

Request Body

JobPrototype

Job prototype

image_reference

Required *

run_commands

array

run_compute_resource_token_enabled

boolean

Optional flag to enable the use of a compute resource token mounted to the container file system.

run_env_variables

array

Optional references to config maps, secrets or literal values.

integer

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`.

Response

image_secret

string

name

string

The name of the job.

project_id

string

The ID of the project in which the resource is located.

region

string

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'.

resource_type

string

The type of the job.

run_arguments

array

run_as_user

integer

The user ID (UID) to run the job.

run_commands

array

run_compute_resource_token_enabled

boolean

Optional flag to enable the use of a compute resource token mounted to the container file system.

run_env_variables

array

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.

string

Lowercase UUID uniquely identifying the request

Delete a job

DELETE /projects/{project_id}/jobs/{name}

Delete a job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.job.delete

Request

Path Parameters

Query Parameters

keep_service_access

boolean

Determines if connected service access secrets remain intact after job deletion.

Response

Lowercase UUID uniquely identifying the request

Get a job

GET /projects/{project_id}/jobs/{name}

Display the details of a job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.job.read

Request

Response

image_secret

string

name

string

The name of the job.

project_id

string

The ID of the project in which the resource is located.

region

string

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'.

resource_type

string

The type of the job.

run_arguments

array

run_as_user

integer

The user ID (UID) to run the job.

run_commands

array

run_compute_resource_token_enabled

boolean

Optional flag to enable the use of a compute resource token mounted to the container file system.

run_env_variables

array

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.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Update a job

PATCH /projects/{project_id}/jobs/{name}

Update the given job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.job.read
codeengine.job.update

Request

Request Body

Job patch prototype

Path Parameters

Query Parameters

Response

image_secret

string

name

string

The name of the job.

project_id

string

The ID of the project in which the resource is located.

region

string

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'.

resource_type

string

The type of the job.

run_arguments

array

run_as_user

integer

The user ID (UID) to run the job.

run_commands

array

run_compute_resource_token_enabled

boolean

Optional flag to enable the use of a compute resource token mounted to the container file system.

run_env_variables

array

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.

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

List persistent data stores

GET /projects/{project_id}/persistent_data_stores

List all persistent data stores in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.persistentdatastore.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of persistent data stores per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

integer

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

403 - Forbidden

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

500 - Internal Server Error

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a persistent data store

POST /projects/{project_id}/persistent_data_stores

Create a persistent data store.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.persistentdatastore.create

Request

Request Body

PersistentDataStorePrototype

PersistentDataStore prototype

data

StorageData

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.

name

Required *

string

The name of the persistent data store.

storage_type

Required *

string

Specify the storage type of the persistent data store.

Response

201 - Created

created_at

string

The timestamp when the resource was created.

Lowercase UUID uniquely identifying the request

Delete a persistent data store

DELETE /projects/{project_id}/persistent_data_stores/{name}

Delete a persistent data store.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.persistentdatastore.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a persistent data store

GET /projects/{project_id}/persistent_data_stores/{name}

Get a persistent data store.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.persistentdatastore.read

Request

Response

200 - OK

created_at

string

The timestamp when the resource was created.

Lowercase UUID uniquely identifying the request

List secrets

GET /projects/{project_id}/secrets

List all secrets in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read
codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.secret.list

Request

Path Parameters

Query Parameters

format

string

Secret format to filter results by.

limit

integer

Optional maximum number of secrets per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a secret

POST /projects/{project_id}/secrets

Create a secret.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.secret.create

Request

Request Body

SecretPrototype

Secret prototype.

data

SecretData

format

Required *

string

Specify the format of the secret. The format of the secret will determine how the secret is used.

name

Required *

string

The name of the secret.

service_access

ServiceAccessSecretPrototypeProps

Properties for Service Access Secrets

resource_key

object

The service credential associated with the secret.

role

object

A reference to the Role and Role CRN for service binding

service_instance

Required *

object

The IBM Cloud service instance associated with the secret.

serviceid

object

A reference to a Service ID

service_operator

OperatorSecretPrototypeProps

Properties for the IBM Cloud Operator Secrets

resource_group_ids

array

The list of resource groups (by ID) that the operator secret can bind services in

serviceid

object

A reference to the Service ID

Response

201 - Created

created_at

string

The timestamp when the resource was created.

Lowercase UUID uniquely identifying the request

Delete a secret

DELETE /projects/{project_id}/secrets/{name}

Delete a secret.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.secret.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a secret

GET /projects/{project_id}/secrets/{name}

Get a secret.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read
codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.secret.read

Request

Response

200 - OK

created_at

string

The timestamp when the resource was created.

Lowercase UUID uniquely identifying the request

Update a secret

PUT /projects/{project_id}/secrets/{name}

Update a secret.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.secret.read
codeengine.secret.update

Request

Request Body

SecretPatch

Secret patch.

data

SecretData

format

Required *

string

Specify the format of the secret. The format of the secret will determine how the secret is used.

Path Parameters

Query Parameters

Response

200 - OK

created_at

string

The timestamp when the resource was created.

Lowercase UUID uniquely identifying the request

Get project settings

GET /projects/{project_id}/settings

Get all project-level settings (fleet, monitoring, logging, registry, connectivity).

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.projectsettings.read

Request

Response

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Update project settings

PATCH /projects/{project_id}/settings

Update project-level settings (fleet, monitoring, logging, registry, connectivity). Only sub-objects present in the request body are updated.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.update

Auditing

Calling this method generates the following auditing event.

codeengine.projectsettings.read
codeengine.projectsettings.update

Request

Request Body

Project settings patch

Path Parameters

Query Parameters

Response

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Get the status details for a project

GET /projects/{project_id}/status_details

Retrieves status details about the given project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Request

Path Parameters

project_id

Required *

string

The ID of the project.

Query Parameters

version

string

The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between `2021-03-31` and `2026-11-03`.

Response

200 - OK

cbr

CbrStatus

Status of the Context-based-restriction configuration applicable for this project.

domain

Lowercase UUID uniquely identifying the request

List subnet pools

GET /projects/{project_id}/subnet_pools

List all subnet pools in a project.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.subnetpool.list

Request

Path Parameters

Query Parameters

limit

integer

Optional maximum number of subnet pools per page.

start

string

Response

200 - OK

first

ListFirstMetadata

Describes properties needed to retrieve the first page of a result list.

limit

integer

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

403 - Forbidden

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

500 - Internal Server Error

errors

array

Contains an array with at least one error model.

status_code

integer

Status code used for the response.

trace

string

Lowercase UUID uniquely identifying the request

Create a subnet pool

POST /projects/{project_id}/subnet_pools

Create a subnet pool.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.create

Auditing

Calling this method generates the following auditing event.

codeengine.subnetpool.create

Request

Request Body

SubnetPoolPrototype

Subnet pool prototype.

name

Required *

string

The name of the subnet pool. Use a name that is unique within the project.

pool

Required *

array

List of referenced subnets and security groups.

Response

Lowercase UUID uniquely identifying the request

Delete a subnet pool

DELETE /projects/{project_id}/subnet_pools/{id}

Delete a subnet pool.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.delete

Auditing

Calling this method generates the following auditing event.

codeengine.subnetpool.delete

Request

Response

Lowercase UUID uniquely identifying the request

Get a subnet pool

GET /projects/{project_id}/subnet_pools/{id}

Get a subnet pool.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

codeengine.tenant.entities.read

Auditing

Calling this method generates the following auditing event.

codeengine.subnetpool.read

Request

Response

Lowercase UUID uniquely identifying the request

List the function runtimes

Authorization

Request

Response

200 - OK

function_runtimes

400 - Bad Request

errors

status_code

trace

401 - Unauthorized

errors

status_code

trace

403 - Forbidden

errors

status_code

trace

404 - Not Found

errors

status_code

trace

500 - Internal Server Error

errors

status_code

trace

List all projects

Authorization

Request

Path Parameters

Query Parameters

limit

start

Response

200 - OK

first

limit

next

projects

400 - Bad Request

errors

status_code

trace

401 - Unauthorized

errors

status_code

trace

403 - Forbidden

errors

status_code

trace

500 - Internal Server Error

errors

status_code

trace

Create a project

Authorization

Auditing

Request

Request Body

name

resource_group_id

tags

Response

202 - Accepted

account_id

created_at

crn

href

id

name

region

resource_group_id

resource_type

status

400 - Bad Request

errors

status_code

trace

401 - Unauthorized