Projects

Validate the provided git ref

post/projects/{projectId}/git/validate

Request

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

projectIdstring required

ID of the Project

Request body

GitRefstring required
ProjectIdstring required

ID of the Project

SpaceIdstring required

Example request

{
  "ProjectId": "Projects-1",
  "SpaceId": "Spaces-1"
}

Response

Validated Git ref or error message

Errorstring

Example response

{
  "ValidatedGitRef": {
    "Links": {
      "Self": "/api/..."
    }
  }
}

Changes

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