ProjectTriggers

Modify a ProjectTriggerResource by ID

Updates an existing project trigger

put/{spaceId}/projects/{projectId}/triggers/{id}

Request

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

spaceIdstring required

Id of the space where the project is located

projectIdstring required

ProjectId of the project trigger

idstring required

Id of the project trigger

Request body

Descriptionstring

Description for the project trigger

Idstring required

Id of the project trigger

IsDisabledboolean

Disables the trigger from being run when set

Namestring

Name of the project trigger

ProjectIdstring required

ProjectId of the project trigger

SpaceIdstring required

Id of the space where the project is located

Example request

{
  "Action": {
    "Links": {
      "Self": "/api/..."
    }
  },
  "Filter": {
    "Links": {
      "Self": "/api/..."
    }
  },
  "Id": "ProjectTriggers-1",
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Response

Modified project trigger resource response

Descriptionstring
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
ProjectIdstring
SpaceIdstring

Example response

{
  "Action": {
    "Links": {
      "Self": "/api/..."
    }
  },
  "Filter": {
    "Links": {
      "Self": "/api/..."
    }
  },
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

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