Insights

Update an existing Insights Report

Updates an existing Insights Report

put/{spaceId}/insights/reports/{id}/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/insights/reports/{id}/v1
  • 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).

idstring required

The Id of the Insights Report

Request body

AllTenantsboolean required

If true, all tenants in the space will be included in the report.

ChannelIdsstring[] required

The channels for the report.

Descriptionstring

The description for the report.

Idstring required

The Id of the Insights Report

Namestring required

The name of the report.

ProjectGroupIdsstring[] required

The project groups for the report.

ProjectIdsstring[] required

The projects for the report.

SpaceIdstring required

The ID of the space containing the resource(s).

TenantIdsstring[] required

The tenants for the report.

TenantMode'Untenanted' | 'TenantedAndUntenanted' | 'Tenanted' required

The kind of deployments that will be included in this report

TenantTagsstring[] required

The tenant tags for the report.

TimeZonestring required

The timezone of the report.

Example request

{
  "ChannelIds": [
    "Channels-1",
    "..."
  ],
  "EnvironmentGroups": [
    {
      "Environments": [
        "Environments-1",
        "..."
      ]
    }
  ],
  "Id": "InsightsReports-1",
  "ProjectGroupIds": [
    "ProjectGroups-1",
    "..."
  ],
  "ProjectIds": [
    "Projects-1",
    "..."
  ],
  "SpaceId": "Spaces-1",
  "TenantIds": [
    "Tenants-1",
    "..."
  ]
}

Response

Success

Example response

{
  "Report": {
    "ChannelIds": [
      "Channels-1",
      "..."
    ],
    "EnvironmentGroups": [
      {
        "Environments": [
          "Environments-1",
          "..."
        ]
      }
    ],
    "Id": "InsightsReports-1",
    "Links": {
      "Self": "/api/..."
    },
    "ProjectGroupIds": [
      "ProjectGroups-1",
      "..."
    ],
    "ProjectIds": [
      "Projects-1",
      "..."
    ],
    "SpaceId": "Spaces-1",
    "TenantIds": [
      "Tenants-1",
      "..."
    ]
  }
}

Changes

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