IOionworks

Update a project within an organization

Changed on
patch/projects/{project_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/projects/{project_id}
  • Auth
    none declared

Path parameters

project_idstring uuid required

Request body

namestring nullable

The name of the project.

descriptionstring nullable

An optional description for the project.

Response

Successful Response

namestring required

The name of the project.

descriptionstring nullable

An optional description for the project.

idstring required

The unique identifier for the project.

organization_idstring required

The ID of the organization this project belongs to.

created_atstring date-time required

Timestamp of when the project was created.

updated_atstring date-time required

Timestamp of when the project was last updated.

created_bystring nullable

User ID of the creator.

my_rolestring nullable

The caller's role in the project, or null if they are not a member.

my_permissionsstring[]

The permission actions the caller's project role grants, e.g. pipeline:read. Empty if they are not a member.

Changes

  • fb09ebb2c64eRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ea3d377fec1aRevision changes
    • breaking

      for the path request parameter project_id, the format changed from no format to uuid