Updating a Project

You can update a project using Cockpit and OKS CLI.

Updating a Project Using Cockpit

In the Projects dashboard, hover over the row of the project you want to update and click the action menu.
A drop-down menu appears.
Click Update Project.
The UPDATE PROJECT dialog box appears.
(optional) In the Description field, type a description of the project.
(optional) Check or uncheck the Disable API termination box:
- If the box is checked, you cannot delete the project through the API.
- If the box is unchecked, you can delete the project through the API.
Click Update Project.
The project is updated.

Updating a Project Using octl

The UpdateProject command updates the details of an existing project.

Request sample

$ octl kube api UpdateProject <project_id> --profile "default" \
  --Description "string" \
  --Tags.Key "value" \
  --Quirks "string" \
  --DisableApiTermination=true

This command contains the following options that you need to specify:

Description: (optional) The updated description for the project.
DisableApiTermination: (optional) If true, project deletion through the API is disabled. If false, it is enabled.
Quirks: (optional) The updated list of special configurations or behaviors for the project.
Tags: (optional) The updated key/value combinations of the tags associated with the project’s metadata, in the following format: "tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}.
Example: {"key": "value"}.

The UpdateProject command returns the following elements:

ResponseContext: Information about the context of the response.
- RequestId: The ID of the API request.
Project: Information about the project.
- id: The ID of the project.
- name: The name of the project.
- description: A description for the project.
  Default: .
- cidr: The CIDR block associated with the Net of the project.
- region: The Region on which the project is deployed.
- status: The status of the project (pending | ready | updating | failed | deleting).
- tags: The key/value combinations of the tags associated with the resource, in the following format: "tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}.
- net_specific: The field to configure network-specific behavior for the VPC of the project.
  - disable_lan_security_groups: The value used to modify the firewall behavior within the VPC.
- disable_api_termination: If true, project deletion through the API is disabled. If false, it is enabled.
  Default: false.
- created_at: The timestamp when the project was created.
- updated_at: The timestamp when the project was last updated.
- deleted_at: The timestamp when the project was deleted (if applicable).

Result sample

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Project": {
    "id": "string",
    "name": "string",
    "description": "",
    "cidr": "string",
    "region": "string",
    "status": "string",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "net_specific": {
      "disable_lan_security_groups": true
    },
    "disable_api_termination": false,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  }
}

Updating a Project Using OKS CLI

The project update command allows you to modify certain project options:

The specified project will then be redeployed with the latest OMI versions.

Request sample

$ oks-cli project update \
    --project-name NAME_OF_PROJECT \
    --description "DESCRIPTION_OF_PROJECT" \
    --tags \
    --disable-api-termination true \
    --output json

This command contains the following options that you need to specify:

project-name: The name of the project that you want to update.
(optional) description: The updated description for the project.
(optional) tags: The updated tags for the project.
(optional) quirk: Advanced keys and parameters to pass to the control plane of the project. This option is required for feature requests.
(optional) disable-api-termination: The ability to delete the project through the API. If true, project deletion is disabled. If false, it is enabled.
(optional) output: The output format for the response (json | yaml). By default, the response format is JSON.

Result sample

{
    "id": "12ca0d38-2927-4cf1-93de-049135f88f00",
    "name": "NAME_OF_PROJECT",
    "description": "DESCRIPTION_OF_PROJECT",
    "cidr": "10.50.0.0/16",
    "region": "eu-west-2",
    "status": "ready",
    "tags": {
        "tag1": "this",
        "tag2": "that"
    },
    "disable_api_termination": true,
    "created_at": "2025-01-01T12:10:00.000000Z",
    "updated_at": "2025-01-02T17:00:00.000000Z",
    "deleted_at": null
}

The project update command returns the following elements:

id: The unique identifier of the project.
name: The name of the project.
description: The description of the project.
cidr: The CIDR block allocated for VPC subnets where cluster VMs will run.
region: The Region where the project is deployed.

status: The current state of the project.

A project can be in one of the following states:

pending: The underlying resources of the project are being initialized.
ready: The project is fully set up and ready for use.
updating: The project is currently updating.
failed: The project has failed. To remedy this, contact our Support team at support@outscale.com.
deleting: The project is in the process of being deleted, and its associated resources are being cleaned up.

tags: One or more tags associated with the project.
net_specific: A set of network-specific configuration options for the project.
- disable_lan_security_groups: Indicates whether LAN security groups are disabled for the project.
disable-api-termination: The ability to delete the project through the API. If true, project deletion is disabled. If false, it is enabled.
created_at: The date and time, in UTC format, at which the project was created.
updated_at: The date and time, in UTC format, at which the project was last updated.
deleted_at: The date and time, in UTC format, at which the project was deleted (null if the project is still active).
organization_id: The organization to which the project belongs.

Related Pages

Corresponding API Method

UpdateProject (OKS API)