ProjectGroups

List Project Groups (unpaginated)

List the name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

get/{spaceId}/projectgroups/all

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/projectgroups/all
  • 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

spaceIdstring required

Response

The name and ID of all of the Project Groups in the supplied Octopus Deploy Space. The results are sorted alphabetically by name."

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.