DashboardConfiguration

Get dashboard configuration

Gets the dashboard configuration of the authenticated user for the current space

get/{spaceId}/dashboardconfiguration

Request

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

The ID of the space containing the resource(s)

Response

The requested Dashboard Configuration

HideInactiveProjectsboolean
Idstring

Gets or sets a unique identifier for this resource.

IncludedEnvironmentIdsstring[]
IncludedEnvironmentTagsstring[]
IncludedProjectGroupIdsstring[]
IncludedProjectIdsstring[]
IncludedProjectTagsstring[]
IncludedTenantIdsstring[]
IncludedTenantTagsstring[]
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
SpaceIdstring

Example response

{
  "IncludedEnvironmentIds": [
    "Environments-1",
    "..."
  ],
  "IncludedProjectIds": [
    "Projects-1",
    "..."
  ],
  "IncludedTenantIds": [
    "Tenants-1",
    "..."
  ],
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

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