DashboardConfiguration

Modify dashboard configuration

Modifies the dashboard configuration for the current user per space

put/dashboardconfiguration

Request

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

Request body

HideInactiveProjectsboolean

Whether to hide inactive projects on the dashboard.

IncludedEnvironmentIdsstring[]

The ids of environments to be displayed on the dashboard.

IncludedEnvironmentTagsstring[]

The canonical tag names of environments to display on the dashboard.

IncludedProjectGroupIdsstring[]

The ids of project groups to be displayed on the dashboard.

IncludedProjectIdsstring[]

The ids of projects to be displayed on the dashboard.

IncludedProjectTagsstring[]

The canonical tag names of projects to display on the dashboard.

IncludedTenantIdsstring[]

The ids of tenants to be displayed on the dashboard.

IncludedTenantTagsstring[]

The canonical tag names to display on the dashboard.

ProjectLimitinteger

The maximum number of projects to display on the dashboard

SpaceIdstring required

The id of the space for the DashboardConfiguration.

Example request

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

Response

Confirmation that the Dashboard Configuration was modified, containing the new 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.