Dashboard

Return information required to render the Octopus dashboard

get/{spaceId}/dashboard

Request

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

Query parameters

highestLatestVersionPerProjectAndEnvironmentboolean
projectIdstring
releaseIdstring
selectedTagsstring[]
selectedTenantsstring[]
showAllboolean

Response

The requested Dashboard

Idstring

Gets or sets a unique identifier for this resource.

IsFilteredboolean
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.

ProjectLimitinteger

Example response

{
  "Environments": [
    {
      "Links": {
        "Self": "/api/..."
      }
    }
  ],
  "Items": [
    {
      "ChannelId": "Channels-1",
      "DeploymentId": "Deployments-1",
      "EnvironmentId": "Environments-1",
      "Id": "Deployments-1",
      "Links": {
        "Self": "/api/..."
      },
      "ProjectId": "Projects-1",
      "ReleaseId": "Releases-1",
      "TenantId": "Tenants-1"
    }
  ],
  "Links": {
    "Self": "/api/..."
  },
  "ProjectGroups": [
    {
      "EnvironmentIds": [
        "Environments-1",
        "..."
      ],
      "Links": {
        "Self": "/api/..."
      }
    }
  ],
  "Projects": [
    {
      "EnvironmentIds": [
        "Environments-1",
        "..."
      ],
      "Links": {
        "Self": "/api/..."
      }
    }
  ],
  "Tenants": [
    {
      "Links": {
        "Self": "/api/..."
      }
    }
  ]
}

Changes

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