Subscriptions

Update an existing Subscription

put/spaces/{spaceIdentifier}/subscriptions/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/subscriptions/{id}
  • 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

spaceIdentifierstring required

Identifier (ID or slug) of the space

idstring required

ID of the Subscription to modify

Request body

Idstring required

ID of the Subscription to modify

IsDisabledboolean
Namestring required
SpaceIdstring required

The ID of the space containing the resource.

Type'Event'

Example request

{
  "EventNotificationSubscription": {
    "Filter": {
      "Tenants": [
        "Tenants-1",
        "..."
      ]
    }
  },
  "Id": "Subscriptions-1",
  "SpaceId": "Spaces-1"
}

Response

The updated Subscription

Idstring

Gets or sets a unique identifier for this resource.

IsDisabledboolean
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
SpaceIdstring
Type'Event'

Example response

{
  "EventNotificationSubscription": {
    "Filter": {
      "Tenants": [
        "Tenants-1",
        "..."
      ]
    }
  },
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

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