Definitions - Delete

  • Reference
Service:
Release
API Version:
5.1

Delete a release definition.

DELETE https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version=5.1
With optional parameters: 
DELETE https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?comment={comment}&forceDelete={forceDelete}&api-version=5.1

URI Parameters

Name In Required Type Description
definitionId
 path True

integer

int32

Id of the release definition.
organization
 path True

string

The name of the Azure DevOps organization.
project
 path True

string

Project ID or project name
api-version
 query True

string

Version of the API to use. This should be set to '5.1' to use this version of the api.
comment
 query

string

Comment for deleting a release definition.
forceDelete
 query

boolean

'true' to automatically cancel any in-progress release deployments and proceed with release definition deletion . Default is 'false'.

Responses

Name Type Description
200 OK

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.release_manage Grants the ability to read, update and delete release artifacts, including folders, releases, release definitions and release environment and the ability to queue and approve a new release.

Examples

Delete a release definition

Sample Request

DELETE https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version=5.1

Sample Response

Status code:
204