Update metadata of an existing Application

Update metadata of an existing Application in the specified Organization.

patch/orgs/{orgId}/apps/{appId}

Path parameters

orgIdstring required

The Organization ID

appIdstring required

The Application ID

Request body

namestring required

The Human-friendly name for the Application.

Example request

{
  "description": "Example Environment Type description"
}

Response

Application updated.

created_atstring required

The timestamp in UTC indicates when the Application was created.

created_bystring required

The user who created the Application.

idstring required

The ID which refers to a specific application.

namestring required

The Human-friendly name for the Application.

org_idstring required

The Organization id of this Application

status'active' | 'deleting' required

The status of the application

status_changed_atstring date-time required

The timestamp in UTC of when the Environment status was last changed.

status_messagestring

The message associated with the status of the environment

Example response

{
  "created_at": "2020-05-22T14:53:27Z",
  "created_by": "a.user@example.com",
  "status": "active",
  "status_changed_at": "2020-05-22T14:53:27Z",
  "envs": [
    {
      "id": "my-env",
      "name": "My Environment"
    }
  ],
  "id": "my-app",
  "name": "My Application"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.