ProjectGroups

Modify an existing project group.

put/projectgroups/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/projectgroups/{id}
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

idstring required

The ID of the project group.

Request body

Descriptionstring

The description of the project group

Idstring required

The ID of the project group.

Namestring required

The name of the project group.

Slugstring
SpaceIdstring required

The ID of the space containing the resource(s).

Example request

{
  "Id": "ProjectGroups-1",
  "SpaceId": "Spaces-1"
}

Response

The modified project group

Descriptionstring
EnvironmentIdsstring[]

Gets or sets a collection of environment ID's. If this collection is empty, projects in this group can be deployed to any environment. If the collection is non-empty, then projects in the group are limited to only deploying to the environments listed in this collection. Obsolete. Environments are now controlled by lifecycles as of Oct 2014, version 2.6.5.

Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Namestring

Gets or sets the name of this project group.

RetentionPolicyIdstring

Gets or sets the ID of the retention policy that will apply to projects in this group.

Slugstring
SpaceIdstring

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.