Spaces

Get a list of Spaces

Lists all Spaces. The results will be sorted alphabetically by name.

get/spaces/all

Request

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

Query parameters

partialNamestring

A partial or complete name to search on. This will perform a contains style match against the supplied name or name-fragment

Response

The requested list of Spaces

Descriptionstring
Idstring

Gets or sets a unique identifier for this resource.

IsDefaultboolean
IsPrivateboolean
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
Slugstring
SpaceManagersTeamMembersstring[]
SpaceManagersTeamsstring[]
TaskQueueStoppedboolean

Example response

[
  {
    "ExtensionSettings": [],
    "Icon": {
      "Color": "#3CA4F3",
      "Id": "rocket"
    },
    "Links": {
      "Self": "/api/..."
    },
    "SpaceManagersTeamMembers": [
      "Users-1",
      "..."
    ]
  }
]

Changes

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